@openremote/rest 1.17.1 → 1.17.2

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