@openremote/rest 1.9.0-snapshot.20250905083755 → 1.9.0-snapshot.20250905092659
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 +457 -457
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -62,31 +62,29 @@ export declare class AlarmResourceClient<O> {
|
|
|
62
62
|
realm?: string;
|
|
63
63
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
64
64
|
}
|
|
65
|
-
export declare class
|
|
65
|
+
export declare class ProvisioningResourceClient<O> {
|
|
66
66
|
protected httpClient: HttpClient<O>;
|
|
67
67
|
constructor(httpClient: HttpClient<O>);
|
|
68
68
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
69
|
+
* HTTP POST /provisioning
|
|
70
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
71
71
|
*/
|
|
72
|
-
|
|
72
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
73
73
|
/**
|
|
74
|
-
* HTTP
|
|
75
|
-
* Java method: org.openremote.model.
|
|
74
|
+
* HTTP GET /provisioning
|
|
75
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
76
76
|
*/
|
|
77
|
-
|
|
77
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
78
78
|
/**
|
|
79
|
-
* HTTP
|
|
80
|
-
* Java method: org.openremote.model.
|
|
79
|
+
* HTTP DELETE /provisioning/{id}
|
|
80
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
81
81
|
*/
|
|
82
|
-
|
|
83
|
-
path?: string;
|
|
84
|
-
}, options?: O): RestResponse<string>;
|
|
82
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
85
83
|
/**
|
|
86
|
-
* HTTP
|
|
87
|
-
* Java method: org.openremote.model.
|
|
84
|
+
* HTTP PUT /provisioning/{id}
|
|
85
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
88
86
|
*/
|
|
89
|
-
|
|
87
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
90
88
|
}
|
|
91
89
|
export declare class ConsoleResourceClient<O> {
|
|
92
90
|
protected httpClient: HttpClient<O>;
|
|
@@ -97,39 +95,148 @@ export declare class ConsoleResourceClient<O> {
|
|
|
97
95
|
*/
|
|
98
96
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
99
97
|
}
|
|
100
|
-
export declare class
|
|
98
|
+
export declare class UserResourceClient<O> {
|
|
101
99
|
protected httpClient: HttpClient<O>;
|
|
102
100
|
constructor(httpClient: HttpClient<O>);
|
|
103
101
|
/**
|
|
104
|
-
* HTTP
|
|
105
|
-
* Java method: org.openremote.model.security.
|
|
102
|
+
* HTTP PUT /user/locale
|
|
103
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
106
104
|
*/
|
|
107
|
-
|
|
105
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
108
106
|
/**
|
|
109
|
-
* HTTP
|
|
110
|
-
* Java method: org.openremote.model.security.
|
|
107
|
+
* HTTP POST /user/query
|
|
108
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
111
109
|
*/
|
|
112
|
-
|
|
110
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
113
111
|
/**
|
|
114
|
-
* HTTP
|
|
115
|
-
* Java method: org.openremote.model.security.
|
|
112
|
+
* HTTP PUT /user/request-password-reset
|
|
113
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
116
114
|
*/
|
|
117
|
-
|
|
115
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
118
116
|
/**
|
|
119
|
-
* HTTP
|
|
120
|
-
* Java method: org.openremote.model.security.
|
|
117
|
+
* HTTP PUT /user/reset-password
|
|
118
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
121
119
|
*/
|
|
122
|
-
|
|
120
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
123
121
|
/**
|
|
124
|
-
* HTTP
|
|
125
|
-
* Java method: org.openremote.model.security.
|
|
122
|
+
* HTTP PUT /user/update
|
|
123
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
126
124
|
*/
|
|
127
|
-
|
|
125
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
128
126
|
/**
|
|
129
|
-
* HTTP
|
|
130
|
-
* Java method: org.openremote.model.security.
|
|
127
|
+
* HTTP GET /user/user
|
|
128
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
131
129
|
*/
|
|
132
|
-
|
|
130
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
131
|
+
/**
|
|
132
|
+
* HTTP GET /user/userRealmRoles
|
|
133
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
134
|
+
*/
|
|
135
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
136
|
+
/**
|
|
137
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
138
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
139
|
+
*/
|
|
140
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
141
|
+
/**
|
|
142
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
143
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
144
|
+
*/
|
|
145
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
146
|
+
/**
|
|
147
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
148
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
149
|
+
*/
|
|
150
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
151
|
+
/**
|
|
152
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
153
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
154
|
+
*/
|
|
155
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
156
|
+
/**
|
|
157
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
158
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
159
|
+
*/
|
|
160
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
161
|
+
/**
|
|
162
|
+
* HTTP PUT /user/{realm}/roles
|
|
163
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
164
|
+
*/
|
|
165
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
166
|
+
/**
|
|
167
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
168
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
169
|
+
*/
|
|
170
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
171
|
+
/**
|
|
172
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
173
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
174
|
+
*/
|
|
175
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
176
|
+
/**
|
|
177
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
178
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
179
|
+
*/
|
|
180
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
181
|
+
/**
|
|
182
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
183
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
184
|
+
*/
|
|
185
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
186
|
+
/**
|
|
187
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
188
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
189
|
+
*/
|
|
190
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
191
|
+
/**
|
|
192
|
+
* HTTP POST /user/{realm}/users
|
|
193
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
194
|
+
*/
|
|
195
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
196
|
+
/**
|
|
197
|
+
* HTTP PUT /user/{realm}/users
|
|
198
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
199
|
+
*/
|
|
200
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
201
|
+
/**
|
|
202
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
203
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
204
|
+
*/
|
|
205
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
206
|
+
/**
|
|
207
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
208
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
209
|
+
*/
|
|
210
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
211
|
+
/**
|
|
212
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
213
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
214
|
+
*/
|
|
215
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
216
|
+
/**
|
|
217
|
+
* HTTP GET /user/{realm}/{userId}
|
|
218
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
219
|
+
*/
|
|
220
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
221
|
+
}
|
|
222
|
+
export declare class FlowResourceClient<O> {
|
|
223
|
+
protected httpClient: HttpClient<O>;
|
|
224
|
+
constructor(httpClient: HttpClient<O>);
|
|
225
|
+
/**
|
|
226
|
+
* HTTP GET /flow
|
|
227
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
228
|
+
*/
|
|
229
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
230
|
+
/**
|
|
231
|
+
* HTTP GET /flow/{name}
|
|
232
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
233
|
+
*/
|
|
234
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
235
|
+
/**
|
|
236
|
+
* HTTP GET /flow/{type}
|
|
237
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
238
|
+
*/
|
|
239
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
133
240
|
}
|
|
134
241
|
export declare class AgentResourceClient<O> {
|
|
135
242
|
protected httpClient: HttpClient<O>;
|
|
@@ -157,6 +264,25 @@ export declare class AgentResourceClient<O> {
|
|
|
157
264
|
realm?: string;
|
|
158
265
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
159
266
|
}
|
|
267
|
+
export declare class AppResourceClient<O> {
|
|
268
|
+
protected httpClient: HttpClient<O>;
|
|
269
|
+
constructor(httpClient: HttpClient<O>);
|
|
270
|
+
/**
|
|
271
|
+
* HTTP GET /apps
|
|
272
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
273
|
+
*/
|
|
274
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
275
|
+
/**
|
|
276
|
+
* HTTP GET /apps/consoleConfig
|
|
277
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
278
|
+
*/
|
|
279
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
280
|
+
/**
|
|
281
|
+
* HTTP GET /apps/info
|
|
282
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
283
|
+
*/
|
|
284
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
285
|
+
}
|
|
160
286
|
export declare class SyslogResourceClient<O> {
|
|
161
287
|
protected httpClient: HttpClient<O>;
|
|
162
288
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -189,106 +315,185 @@ export declare class SyslogResourceClient<O> {
|
|
|
189
315
|
subCategory?: string[];
|
|
190
316
|
}, options?: O): RestResponse<any>;
|
|
191
317
|
}
|
|
192
|
-
export declare class
|
|
318
|
+
export declare class RealmResourceClient<O> {
|
|
193
319
|
protected httpClient: HttpClient<O>;
|
|
194
320
|
constructor(httpClient: HttpClient<O>);
|
|
195
321
|
/**
|
|
196
|
-
* HTTP
|
|
197
|
-
* Java method: org.openremote.model.
|
|
322
|
+
* HTTP POST /realm
|
|
323
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
198
324
|
*/
|
|
199
|
-
|
|
325
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
200
326
|
/**
|
|
201
|
-
* HTTP GET /
|
|
202
|
-
* Java method: org.openremote.model.
|
|
327
|
+
* HTTP GET /realm
|
|
328
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
203
329
|
*/
|
|
204
|
-
|
|
330
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
205
331
|
/**
|
|
206
|
-
* HTTP GET /
|
|
207
|
-
* Java method: org.openremote.model.
|
|
332
|
+
* HTTP GET /realm/accessible
|
|
333
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
208
334
|
*/
|
|
209
|
-
|
|
210
|
-
}
|
|
211
|
-
export declare class MapResourceClient<O> {
|
|
212
|
-
protected httpClient: HttpClient<O>;
|
|
213
|
-
constructor(httpClient: HttpClient<O>);
|
|
335
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
214
336
|
/**
|
|
215
|
-
* HTTP
|
|
216
|
-
* Java method: org.openremote.model.
|
|
337
|
+
* HTTP DELETE /realm/{name}
|
|
338
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
217
339
|
*/
|
|
218
|
-
|
|
219
|
-
[id: string]: unknown;
|
|
220
|
-
}>;
|
|
340
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
221
341
|
/**
|
|
222
|
-
* HTTP
|
|
223
|
-
* Java method: org.openremote.model.
|
|
342
|
+
* HTTP GET /realm/{name}
|
|
343
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
224
344
|
*/
|
|
225
|
-
|
|
226
|
-
[id: string]: unknown;
|
|
227
|
-
}>;
|
|
345
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
228
346
|
/**
|
|
229
|
-
* HTTP
|
|
230
|
-
* Java method: org.openremote.model.
|
|
347
|
+
* HTTP PUT /realm/{name}
|
|
348
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
231
349
|
*/
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
350
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
351
|
+
}
|
|
352
|
+
export declare class ConfigurationResourceClient<O> {
|
|
353
|
+
protected httpClient: HttpClient<O>;
|
|
354
|
+
constructor(httpClient: HttpClient<O>);
|
|
235
355
|
/**
|
|
236
|
-
* HTTP GET /
|
|
237
|
-
* Java method: org.openremote.model.
|
|
356
|
+
* HTTP GET /configuration/manager
|
|
357
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
238
358
|
*/
|
|
239
|
-
|
|
240
|
-
[id: string]: unknown;
|
|
241
|
-
}>;
|
|
359
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
242
360
|
/**
|
|
243
|
-
* HTTP
|
|
244
|
-
* Java method: org.openremote.model.
|
|
361
|
+
* HTTP PUT /configuration/manager
|
|
362
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
245
363
|
*/
|
|
246
|
-
|
|
247
|
-
[id: string]: unknown;
|
|
248
|
-
}>;
|
|
364
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
249
365
|
/**
|
|
250
|
-
* HTTP
|
|
251
|
-
* Java method: org.openremote.model.
|
|
366
|
+
* HTTP POST /configuration/manager/file
|
|
367
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
252
368
|
*/
|
|
253
|
-
|
|
369
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
370
|
+
path?: string;
|
|
371
|
+
}, options?: O): RestResponse<string>;
|
|
254
372
|
/**
|
|
255
|
-
* HTTP
|
|
256
|
-
* Java method: org.openremote.model.
|
|
373
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
374
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
257
375
|
*/
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
376
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
377
|
+
}
|
|
378
|
+
export declare class StatusResourceClient<O> {
|
|
379
|
+
protected httpClient: HttpClient<O>;
|
|
380
|
+
constructor(httpClient: HttpClient<O>);
|
|
381
|
+
/**
|
|
382
|
+
* HTTP GET /health
|
|
383
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
384
|
+
*/
|
|
385
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
386
|
+
[index: string]: any;
|
|
387
|
+
}>;
|
|
388
|
+
/**
|
|
389
|
+
* HTTP GET /info
|
|
390
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
391
|
+
*/
|
|
392
|
+
getInfo(options?: O): RestResponse<{
|
|
393
|
+
[index: string]: any;
|
|
262
394
|
}>;
|
|
263
395
|
}
|
|
264
|
-
export declare class
|
|
396
|
+
export declare class DashboardResourceClient<O> {
|
|
265
397
|
protected httpClient: HttpClient<O>;
|
|
266
398
|
constructor(httpClient: HttpClient<O>);
|
|
267
399
|
/**
|
|
268
|
-
* HTTP POST /
|
|
269
|
-
* Java method: org.openremote.model.
|
|
400
|
+
* HTTP POST /dashboard
|
|
401
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
270
402
|
*/
|
|
271
|
-
|
|
403
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
272
404
|
/**
|
|
273
|
-
* HTTP
|
|
274
|
-
* Java method: org.openremote.model.
|
|
405
|
+
* HTTP PUT /dashboard
|
|
406
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
275
407
|
*/
|
|
276
|
-
|
|
408
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
277
409
|
/**
|
|
278
|
-
* HTTP GET /
|
|
279
|
-
* Java method: org.openremote.model.
|
|
410
|
+
* HTTP GET /dashboard/all/{realm}
|
|
411
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
280
412
|
*/
|
|
281
|
-
|
|
413
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
282
414
|
/**
|
|
283
|
-
* HTTP
|
|
284
|
-
* Java method: org.openremote.model.
|
|
415
|
+
* HTTP POST /dashboard/query
|
|
416
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
285
417
|
*/
|
|
286
|
-
|
|
418
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
287
419
|
/**
|
|
288
|
-
* HTTP
|
|
289
|
-
* Java method: org.openremote.model.
|
|
420
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
421
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
290
422
|
*/
|
|
291
|
-
|
|
423
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
424
|
+
/**
|
|
425
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
426
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
427
|
+
*/
|
|
428
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
429
|
+
}
|
|
430
|
+
export declare class NotificationResourceClient<O> {
|
|
431
|
+
protected httpClient: HttpClient<O>;
|
|
432
|
+
constructor(httpClient: HttpClient<O>);
|
|
433
|
+
/**
|
|
434
|
+
* HTTP GET /notification
|
|
435
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
436
|
+
*/
|
|
437
|
+
getNotifications(queryParams?: {
|
|
438
|
+
id?: number;
|
|
439
|
+
type?: string;
|
|
440
|
+
from?: number;
|
|
441
|
+
to?: number;
|
|
442
|
+
realmId?: string;
|
|
443
|
+
userId?: string;
|
|
444
|
+
assetId?: string;
|
|
445
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
446
|
+
/**
|
|
447
|
+
* HTTP DELETE /notification
|
|
448
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
449
|
+
*/
|
|
450
|
+
removeNotifications(queryParams?: {
|
|
451
|
+
id?: number;
|
|
452
|
+
type?: string;
|
|
453
|
+
from?: number;
|
|
454
|
+
to?: number;
|
|
455
|
+
realmId?: string;
|
|
456
|
+
userId?: string;
|
|
457
|
+
assetId?: string;
|
|
458
|
+
}, options?: O): RestResponse<void>;
|
|
459
|
+
/**
|
|
460
|
+
* HTTP POST /notification/alert
|
|
461
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
462
|
+
*/
|
|
463
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
464
|
+
/**
|
|
465
|
+
* HTTP DELETE /notification/{notificationId}
|
|
466
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
467
|
+
*/
|
|
468
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
469
|
+
/**
|
|
470
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
471
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
472
|
+
*/
|
|
473
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
474
|
+
targetId?: string;
|
|
475
|
+
}, options?: O): RestResponse<void>;
|
|
476
|
+
/**
|
|
477
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
478
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
479
|
+
*/
|
|
480
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
481
|
+
targetId?: string;
|
|
482
|
+
}, options?: O): RestResponse<void>;
|
|
483
|
+
}
|
|
484
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
485
|
+
protected httpClient: HttpClient<O>;
|
|
486
|
+
constructor(httpClient: HttpClient<O>);
|
|
487
|
+
/**
|
|
488
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
489
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
490
|
+
*/
|
|
491
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
492
|
+
/**
|
|
493
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
494
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
495
|
+
*/
|
|
496
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
292
497
|
}
|
|
293
498
|
export declare class RulesResourceClient<O> {
|
|
294
499
|
protected httpClient: HttpClient<O>;
|
|
@@ -398,85 +603,6 @@ export declare class RulesResourceClient<O> {
|
|
|
398
603
|
*/
|
|
399
604
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
400
605
|
}
|
|
401
|
-
export declare class AssetModelResourceClient<O> {
|
|
402
|
-
protected httpClient: HttpClient<O>;
|
|
403
|
-
constructor(httpClient: HttpClient<O>);
|
|
404
|
-
/**
|
|
405
|
-
* HTTP GET /model/assetDescriptors
|
|
406
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
407
|
-
*/
|
|
408
|
-
getAssetDescriptors(queryParams?: {
|
|
409
|
-
parentId?: string;
|
|
410
|
-
parentType?: string;
|
|
411
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
412
|
-
/**
|
|
413
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
414
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
415
|
-
*/
|
|
416
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
417
|
-
parentId?: string;
|
|
418
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
419
|
-
/**
|
|
420
|
-
* HTTP GET /model/assetInfos
|
|
421
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
422
|
-
*/
|
|
423
|
-
getAssetInfos(queryParams?: {
|
|
424
|
-
parentId?: string;
|
|
425
|
-
parentType?: string;
|
|
426
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
427
|
-
/**
|
|
428
|
-
* HTTP GET /model/metaItemDescriptors
|
|
429
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
430
|
-
*/
|
|
431
|
-
getMetaItemDescriptors(queryParams?: {
|
|
432
|
-
parentId?: string;
|
|
433
|
-
}, options?: O): RestResponse<{
|
|
434
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
435
|
-
}>;
|
|
436
|
-
/**
|
|
437
|
-
* HTTP GET /model/valueDescriptors
|
|
438
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
439
|
-
*/
|
|
440
|
-
getValueDescriptors(queryParams?: {
|
|
441
|
-
parentId?: string;
|
|
442
|
-
}, options?: O): RestResponse<{
|
|
443
|
-
[index: string]: Model.ValueDescriptor;
|
|
444
|
-
}>;
|
|
445
|
-
}
|
|
446
|
-
export declare class DashboardResourceClient<O> {
|
|
447
|
-
protected httpClient: HttpClient<O>;
|
|
448
|
-
constructor(httpClient: HttpClient<O>);
|
|
449
|
-
/**
|
|
450
|
-
* HTTP POST /dashboard
|
|
451
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
452
|
-
*/
|
|
453
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
454
|
-
/**
|
|
455
|
-
* HTTP PUT /dashboard
|
|
456
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
457
|
-
*/
|
|
458
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
459
|
-
/**
|
|
460
|
-
* HTTP GET /dashboard/all/{realm}
|
|
461
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
462
|
-
*/
|
|
463
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
464
|
-
/**
|
|
465
|
-
* HTTP POST /dashboard/query
|
|
466
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
467
|
-
*/
|
|
468
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
469
|
-
/**
|
|
470
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
471
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
472
|
-
*/
|
|
473
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
474
|
-
/**
|
|
475
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
476
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
477
|
-
*/
|
|
478
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
479
|
-
}
|
|
480
606
|
export declare class AssetDatapointResourceClient<O> {
|
|
481
607
|
protected httpClient: HttpClient<O>;
|
|
482
608
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -503,222 +629,132 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
503
629
|
*/
|
|
504
630
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
505
631
|
}
|
|
506
|
-
export declare class
|
|
507
|
-
protected httpClient: HttpClient<O>;
|
|
508
|
-
constructor(httpClient: HttpClient<O>);
|
|
509
|
-
/**
|
|
510
|
-
* HTTP GET /flow
|
|
511
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
512
|
-
*/
|
|
513
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
514
|
-
/**
|
|
515
|
-
* HTTP GET /flow/{name}
|
|
516
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
517
|
-
*/
|
|
518
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
519
|
-
/**
|
|
520
|
-
* HTTP GET /flow/{type}
|
|
521
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
522
|
-
*/
|
|
523
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
524
|
-
}
|
|
525
|
-
export declare class GatewayClientResourceClient<O> {
|
|
526
|
-
protected httpClient: HttpClient<O>;
|
|
527
|
-
constructor(httpClient: HttpClient<O>);
|
|
528
|
-
/**
|
|
529
|
-
* HTTP DELETE /gateway/connection
|
|
530
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
531
|
-
*/
|
|
532
|
-
deleteConnections(queryParams?: {
|
|
533
|
-
realm?: string[];
|
|
534
|
-
}, options?: O): RestResponse<void>;
|
|
535
|
-
/**
|
|
536
|
-
* HTTP GET /gateway/connection
|
|
537
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
538
|
-
*/
|
|
539
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
540
|
-
/**
|
|
541
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
542
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
543
|
-
*/
|
|
544
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
545
|
-
/**
|
|
546
|
-
* HTTP GET /gateway/connection/{realm}
|
|
547
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
548
|
-
*/
|
|
549
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
550
|
-
/**
|
|
551
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
552
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
553
|
-
*/
|
|
554
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
555
|
-
/**
|
|
556
|
-
* HTTP GET /gateway/status/{realm}
|
|
557
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
558
|
-
*/
|
|
559
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
560
|
-
}
|
|
561
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
632
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
562
633
|
protected httpClient: HttpClient<O>;
|
|
563
634
|
constructor(httpClient: HttpClient<O>);
|
|
564
635
|
/**
|
|
565
|
-
* HTTP POST /
|
|
566
|
-
* Java method: org.openremote.model.
|
|
567
|
-
*/
|
|
568
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
569
|
-
/**
|
|
570
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
571
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
636
|
+
* HTTP POST /gateway/tunnel
|
|
637
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
572
638
|
*/
|
|
573
|
-
|
|
574
|
-
}
|
|
575
|
-
export declare class ProvisioningResourceClient<O> {
|
|
576
|
-
protected httpClient: HttpClient<O>;
|
|
577
|
-
constructor(httpClient: HttpClient<O>);
|
|
639
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
578
640
|
/**
|
|
579
|
-
* HTTP
|
|
580
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP DELETE /gateway/tunnel
|
|
642
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
581
643
|
*/
|
|
582
|
-
|
|
644
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
583
645
|
/**
|
|
584
|
-
* HTTP GET /
|
|
585
|
-
* Java method: org.openremote.model.
|
|
646
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
647
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
586
648
|
*/
|
|
587
|
-
|
|
649
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
588
650
|
/**
|
|
589
|
-
* HTTP
|
|
590
|
-
* Java method: org.openremote.model.
|
|
651
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
652
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
591
653
|
*/
|
|
592
|
-
|
|
654
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
593
655
|
/**
|
|
594
|
-
* HTTP
|
|
595
|
-
* Java method: org.openremote.model.
|
|
656
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
657
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
596
658
|
*/
|
|
597
|
-
|
|
659
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
598
660
|
}
|
|
599
|
-
export declare class
|
|
661
|
+
export declare class AssetModelResourceClient<O> {
|
|
600
662
|
protected httpClient: HttpClient<O>;
|
|
601
663
|
constructor(httpClient: HttpClient<O>);
|
|
602
664
|
/**
|
|
603
|
-
* HTTP
|
|
604
|
-
* Java method: org.openremote.model.
|
|
605
|
-
*/
|
|
606
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
607
|
-
/**
|
|
608
|
-
* HTTP POST /user/query
|
|
609
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
610
|
-
*/
|
|
611
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
612
|
-
/**
|
|
613
|
-
* HTTP PUT /user/request-password-reset
|
|
614
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
615
|
-
*/
|
|
616
|
-
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
617
|
-
/**
|
|
618
|
-
* HTTP PUT /user/reset-password
|
|
619
|
-
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
620
|
-
*/
|
|
621
|
-
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
622
|
-
/**
|
|
623
|
-
* HTTP PUT /user/update
|
|
624
|
-
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
625
|
-
*/
|
|
626
|
-
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
627
|
-
/**
|
|
628
|
-
* HTTP GET /user/user
|
|
629
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
630
|
-
*/
|
|
631
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
632
|
-
/**
|
|
633
|
-
* HTTP GET /user/userRealmRoles
|
|
634
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
635
|
-
*/
|
|
636
|
-
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
637
|
-
/**
|
|
638
|
-
* HTTP GET /user/userRoles/{clientId}
|
|
639
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
640
|
-
*/
|
|
641
|
-
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
642
|
-
/**
|
|
643
|
-
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
644
|
-
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
645
|
-
*/
|
|
646
|
-
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
647
|
-
/**
|
|
648
|
-
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
649
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
650
|
-
*/
|
|
651
|
-
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
652
|
-
/**
|
|
653
|
-
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
654
|
-
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
655
|
-
*/
|
|
656
|
-
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
657
|
-
/**
|
|
658
|
-
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
659
|
-
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
660
|
-
*/
|
|
661
|
-
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
662
|
-
/**
|
|
663
|
-
* HTTP PUT /user/{realm}/roles
|
|
664
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
665
|
+
* HTTP GET /model/assetDescriptors
|
|
666
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
665
667
|
*/
|
|
666
|
-
|
|
668
|
+
getAssetDescriptors(queryParams?: {
|
|
669
|
+
parentId?: string;
|
|
670
|
+
parentType?: string;
|
|
671
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
667
672
|
/**
|
|
668
|
-
* HTTP GET /
|
|
669
|
-
* Java method: org.openremote.model.
|
|
673
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
674
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
670
675
|
*/
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
676
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
677
|
+
parentId?: string;
|
|
678
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
679
|
+
/**
|
|
680
|
+
* HTTP GET /model/assetInfos
|
|
681
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
675
682
|
*/
|
|
676
|
-
|
|
683
|
+
getAssetInfos(queryParams?: {
|
|
684
|
+
parentId?: string;
|
|
685
|
+
parentType?: string;
|
|
686
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
677
687
|
/**
|
|
678
|
-
* HTTP GET /
|
|
679
|
-
* Java method: org.openremote.model.
|
|
688
|
+
* HTTP GET /model/metaItemDescriptors
|
|
689
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
680
690
|
*/
|
|
681
|
-
|
|
691
|
+
getMetaItemDescriptors(queryParams?: {
|
|
692
|
+
parentId?: string;
|
|
693
|
+
}, options?: O): RestResponse<{
|
|
694
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
695
|
+
}>;
|
|
682
696
|
/**
|
|
683
|
-
* HTTP
|
|
684
|
-
* Java method: org.openremote.model.
|
|
697
|
+
* HTTP GET /model/valueDescriptors
|
|
698
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
685
699
|
*/
|
|
686
|
-
|
|
700
|
+
getValueDescriptors(queryParams?: {
|
|
701
|
+
parentId?: string;
|
|
702
|
+
}, options?: O): RestResponse<{
|
|
703
|
+
[index: string]: Model.ValueDescriptor;
|
|
704
|
+
}>;
|
|
705
|
+
}
|
|
706
|
+
export declare class MapResourceClient<O> {
|
|
707
|
+
protected httpClient: HttpClient<O>;
|
|
708
|
+
constructor(httpClient: HttpClient<O>);
|
|
687
709
|
/**
|
|
688
|
-
* HTTP GET /
|
|
689
|
-
* Java method: org.openremote.model.
|
|
710
|
+
* HTTP GET /map
|
|
711
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
690
712
|
*/
|
|
691
|
-
|
|
713
|
+
getSettings(options?: O): RestResponse<{
|
|
714
|
+
[id: string]: unknown;
|
|
715
|
+
}>;
|
|
692
716
|
/**
|
|
693
|
-
* HTTP
|
|
694
|
-
* Java method: org.openremote.model.
|
|
717
|
+
* HTTP PUT /map
|
|
718
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
695
719
|
*/
|
|
696
|
-
|
|
720
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
721
|
+
[id: string]: unknown;
|
|
722
|
+
}>;
|
|
697
723
|
/**
|
|
698
|
-
* HTTP
|
|
699
|
-
* Java method: org.openremote.model.
|
|
724
|
+
* HTTP DELETE /map/deleteMap
|
|
725
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
700
726
|
*/
|
|
701
|
-
|
|
727
|
+
deleteMap(options?: O): RestResponse<{
|
|
728
|
+
[id: string]: unknown;
|
|
729
|
+
}>;
|
|
702
730
|
/**
|
|
703
|
-
* HTTP
|
|
704
|
-
* Java method: org.openremote.model.
|
|
731
|
+
* HTTP GET /map/getCustomMapInfo
|
|
732
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
705
733
|
*/
|
|
706
|
-
|
|
734
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
735
|
+
[id: string]: unknown;
|
|
736
|
+
}>;
|
|
707
737
|
/**
|
|
708
|
-
* HTTP GET /
|
|
709
|
-
* Java method: org.openremote.model.
|
|
738
|
+
* HTTP GET /map/js
|
|
739
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
710
740
|
*/
|
|
711
|
-
|
|
741
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
742
|
+
[id: string]: unknown;
|
|
743
|
+
}>;
|
|
712
744
|
/**
|
|
713
|
-
* HTTP
|
|
714
|
-
* Java method: org.openremote.model.
|
|
745
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
746
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
715
747
|
*/
|
|
716
|
-
|
|
748
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
717
749
|
/**
|
|
718
|
-
* HTTP
|
|
719
|
-
* Java method: org.openremote.model.
|
|
750
|
+
* HTTP POST /map/upload
|
|
751
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
720
752
|
*/
|
|
721
|
-
|
|
753
|
+
uploadMap(queryParams?: {
|
|
754
|
+
filename?: string;
|
|
755
|
+
}, options?: O): RestResponse<{
|
|
756
|
+
[id: string]: unknown;
|
|
757
|
+
}>;
|
|
722
758
|
}
|
|
723
759
|
export declare class AssetResourceClient<O> {
|
|
724
760
|
protected httpClient: HttpClient<O>;
|
|
@@ -824,123 +860,87 @@ export declare class AssetResourceClient<O> {
|
|
|
824
860
|
assetIds?: string[];
|
|
825
861
|
}, options?: O): RestResponse<void>;
|
|
826
862
|
}
|
|
827
|
-
export declare class
|
|
828
|
-
protected httpClient: HttpClient<O>;
|
|
829
|
-
constructor(httpClient: HttpClient<O>);
|
|
830
|
-
/**
|
|
831
|
-
* HTTP GET /health
|
|
832
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
833
|
-
*/
|
|
834
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
835
|
-
[index: string]: any;
|
|
836
|
-
}>;
|
|
837
|
-
/**
|
|
838
|
-
* HTTP GET /info
|
|
839
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
840
|
-
*/
|
|
841
|
-
getInfo(options?: O): RestResponse<{
|
|
842
|
-
[index: string]: any;
|
|
843
|
-
}>;
|
|
844
|
-
}
|
|
845
|
-
export declare class NotificationResourceClient<O> {
|
|
863
|
+
export declare class GatewayClientResourceClient<O> {
|
|
846
864
|
protected httpClient: HttpClient<O>;
|
|
847
865
|
constructor(httpClient: HttpClient<O>);
|
|
848
866
|
/**
|
|
849
|
-
* HTTP
|
|
850
|
-
* Java method: org.openremote.model.
|
|
867
|
+
* HTTP DELETE /gateway/connection
|
|
868
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
851
869
|
*/
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
from?: number;
|
|
856
|
-
to?: number;
|
|
857
|
-
realmId?: string;
|
|
858
|
-
userId?: string;
|
|
859
|
-
assetId?: string;
|
|
860
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
870
|
+
deleteConnections(queryParams?: {
|
|
871
|
+
realm?: string[];
|
|
872
|
+
}, options?: O): RestResponse<void>;
|
|
861
873
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP GET /gateway/connection
|
|
875
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
864
876
|
*/
|
|
865
|
-
|
|
866
|
-
id?: number;
|
|
867
|
-
type?: string;
|
|
868
|
-
from?: number;
|
|
869
|
-
to?: number;
|
|
870
|
-
realmId?: string;
|
|
871
|
-
userId?: string;
|
|
872
|
-
assetId?: string;
|
|
873
|
-
}, options?: O): RestResponse<void>;
|
|
877
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
874
878
|
/**
|
|
875
|
-
* HTTP
|
|
876
|
-
* Java method: org.openremote.model.
|
|
879
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
880
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
877
881
|
*/
|
|
878
|
-
|
|
882
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
879
883
|
/**
|
|
880
|
-
* HTTP
|
|
881
|
-
* Java method: org.openremote.model.
|
|
884
|
+
* HTTP GET /gateway/connection/{realm}
|
|
885
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
882
886
|
*/
|
|
883
|
-
|
|
887
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
884
888
|
/**
|
|
885
|
-
* HTTP PUT /
|
|
886
|
-
* Java method: org.openremote.model.
|
|
889
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
890
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
887
891
|
*/
|
|
888
|
-
|
|
889
|
-
targetId?: string;
|
|
890
|
-
}, options?: O): RestResponse<void>;
|
|
892
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
891
893
|
/**
|
|
892
|
-
* HTTP
|
|
893
|
-
* Java method: org.openremote.model.
|
|
894
|
+
* HTTP GET /gateway/status/{realm}
|
|
895
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
894
896
|
*/
|
|
895
|
-
|
|
896
|
-
targetId?: string;
|
|
897
|
-
}, options?: O): RestResponse<void>;
|
|
897
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
901
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
902
|
-
protected
|
|
902
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
903
903
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
904
|
-
protected
|
|
904
|
+
protected _userResource: AxiosUserResourceClient;
|
|
905
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
905
906
|
protected _agentResource: AxiosAgentResourceClient;
|
|
906
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
907
907
|
protected _appResource: AxiosAppResourceClient;
|
|
908
|
-
protected
|
|
909
|
-
protected
|
|
910
|
-
protected
|
|
911
|
-
protected
|
|
908
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
909
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
910
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
911
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
912
912
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
913
|
-
protected
|
|
914
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
915
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
913
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
916
914
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
917
|
-
protected
|
|
918
|
-
protected
|
|
915
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
916
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
917
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
918
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
919
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
919
920
|
protected _assetResource: AxiosAssetResourceClient;
|
|
920
|
-
protected
|
|
921
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
921
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
923
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
924
|
-
get
|
|
924
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
925
925
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
926
|
-
get
|
|
926
|
+
get UserResource(): AxiosUserResourceClient;
|
|
927
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
927
928
|
get AgentResource(): AxiosAgentResourceClient;
|
|
928
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
929
929
|
get AppResource(): AxiosAppResourceClient;
|
|
930
|
-
get
|
|
931
|
-
get
|
|
932
|
-
get
|
|
933
|
-
get
|
|
930
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
931
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
932
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
933
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
934
934
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
935
|
-
get
|
|
936
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
937
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
935
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
938
936
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
939
|
-
get
|
|
940
|
-
get
|
|
937
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
938
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
939
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
940
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
941
|
+
get MapResource(): AxiosMapResourceClient;
|
|
941
942
|
get AssetResource(): AxiosAssetResourceClient;
|
|
942
|
-
get
|
|
943
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
943
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -951,63 +951,63 @@ declare module "axios" {
|
|
|
951
951
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
957
|
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
969
|
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
|
-
export declare class
|
|
978
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
984
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|