@openremote/rest 1.9.0-snapshot.20250930100254 → 1.9.0-snapshot.20251002085656

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