@openremote/rest 1.3.0 → 1.4.0-snapshot.20250221145955
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +427 -427
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,6 +9,213 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class AssetResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP POST /asset
|
|
17
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
18
|
+
*/
|
|
19
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
20
|
+
/**
|
|
21
|
+
* HTTP DELETE /asset
|
|
22
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
23
|
+
*/
|
|
24
|
+
delete(queryParams?: {
|
|
25
|
+
assetId?: string[];
|
|
26
|
+
}, options?: O): RestResponse<void>;
|
|
27
|
+
/**
|
|
28
|
+
* HTTP PUT /asset/attributes
|
|
29
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
30
|
+
*/
|
|
31
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
32
|
+
/**
|
|
33
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
34
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
35
|
+
*/
|
|
36
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
37
|
+
/**
|
|
38
|
+
* HTTP DELETE /asset/parent
|
|
39
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
40
|
+
*/
|
|
41
|
+
updateNoneParent(queryParams?: {
|
|
42
|
+
assetIds?: string[];
|
|
43
|
+
}, options?: O): RestResponse<void>;
|
|
44
|
+
/**
|
|
45
|
+
* HTTP GET /asset/partial/{assetId}
|
|
46
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
47
|
+
*/
|
|
48
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
49
|
+
/**
|
|
50
|
+
* HTTP POST /asset/query
|
|
51
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
52
|
+
*/
|
|
53
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
54
|
+
/**
|
|
55
|
+
* HTTP GET /asset/user/current
|
|
56
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
57
|
+
*/
|
|
58
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
59
|
+
/**
|
|
60
|
+
* HTTP POST /asset/user/link
|
|
61
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
62
|
+
*/
|
|
63
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
64
|
+
/**
|
|
65
|
+
* HTTP GET /asset/user/link
|
|
66
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
67
|
+
*/
|
|
68
|
+
getUserAssetLinks(queryParams?: {
|
|
69
|
+
realm?: string;
|
|
70
|
+
userId?: string;
|
|
71
|
+
assetId?: string;
|
|
72
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
73
|
+
/**
|
|
74
|
+
* HTTP POST /asset/user/link/delete
|
|
75
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
76
|
+
*/
|
|
77
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
78
|
+
/**
|
|
79
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
80
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
81
|
+
*/
|
|
82
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
83
|
+
/**
|
|
84
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
85
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
86
|
+
*/
|
|
87
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
88
|
+
/**
|
|
89
|
+
* HTTP GET /asset/{assetId}
|
|
90
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
91
|
+
*/
|
|
92
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
93
|
+
/**
|
|
94
|
+
* HTTP PUT /asset/{assetId}
|
|
95
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
96
|
+
*/
|
|
97
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
98
|
+
/**
|
|
99
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
100
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
101
|
+
*/
|
|
102
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
103
|
+
/**
|
|
104
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
105
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
106
|
+
*/
|
|
107
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
108
|
+
/**
|
|
109
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
110
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
111
|
+
*/
|
|
112
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
113
|
+
assetIds?: string[];
|
|
114
|
+
}, options?: O): RestResponse<void>;
|
|
115
|
+
}
|
|
116
|
+
export declare class SyslogResourceClient<O> {
|
|
117
|
+
protected httpClient: HttpClient<O>;
|
|
118
|
+
constructor(httpClient: HttpClient<O>);
|
|
119
|
+
/**
|
|
120
|
+
* HTTP GET /syslog/config
|
|
121
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
122
|
+
*/
|
|
123
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
124
|
+
/**
|
|
125
|
+
* HTTP PUT /syslog/config
|
|
126
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
127
|
+
*/
|
|
128
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
129
|
+
/**
|
|
130
|
+
* HTTP DELETE /syslog/event
|
|
131
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
132
|
+
*/
|
|
133
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
134
|
+
/**
|
|
135
|
+
* HTTP GET /syslog/event
|
|
136
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
137
|
+
*/
|
|
138
|
+
getEvents(queryParams?: {
|
|
139
|
+
level?: Model.SyslogLevel;
|
|
140
|
+
per_page?: number;
|
|
141
|
+
page?: number;
|
|
142
|
+
from?: number;
|
|
143
|
+
to?: number;
|
|
144
|
+
category?: Model.SyslogCategory[];
|
|
145
|
+
subCategory?: string[];
|
|
146
|
+
}, options?: O): RestResponse<any>;
|
|
147
|
+
}
|
|
148
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
149
|
+
protected httpClient: HttpClient<O>;
|
|
150
|
+
constructor(httpClient: HttpClient<O>);
|
|
151
|
+
/**
|
|
152
|
+
* HTTP GET /asset/datapoint/export
|
|
153
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
154
|
+
*/
|
|
155
|
+
getDatapointExport(queryParams?: {
|
|
156
|
+
attributeRefs?: string;
|
|
157
|
+
fromTimestamp?: number;
|
|
158
|
+
toTimestamp?: number;
|
|
159
|
+
}, options?: O): RestResponse<any>;
|
|
160
|
+
/**
|
|
161
|
+
* HTTP GET /asset/datapoint/periods
|
|
162
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
163
|
+
*/
|
|
164
|
+
getDatapointPeriod(queryParams?: {
|
|
165
|
+
assetId?: string;
|
|
166
|
+
attributeName?: string;
|
|
167
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
168
|
+
/**
|
|
169
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
170
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
171
|
+
*/
|
|
172
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
173
|
+
}
|
|
174
|
+
export declare class AssetModelResourceClient<O> {
|
|
175
|
+
protected httpClient: HttpClient<O>;
|
|
176
|
+
constructor(httpClient: HttpClient<O>);
|
|
177
|
+
/**
|
|
178
|
+
* HTTP GET /model/assetDescriptors
|
|
179
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
180
|
+
*/
|
|
181
|
+
getAssetDescriptors(queryParams?: {
|
|
182
|
+
parentId?: string;
|
|
183
|
+
parentType?: string;
|
|
184
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
185
|
+
/**
|
|
186
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
187
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
188
|
+
*/
|
|
189
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
190
|
+
parentId?: string;
|
|
191
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
192
|
+
/**
|
|
193
|
+
* HTTP GET /model/assetInfos
|
|
194
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
195
|
+
*/
|
|
196
|
+
getAssetInfos(queryParams?: {
|
|
197
|
+
parentId?: string;
|
|
198
|
+
parentType?: string;
|
|
199
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
200
|
+
/**
|
|
201
|
+
* HTTP GET /model/metaItemDescriptors
|
|
202
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
203
|
+
*/
|
|
204
|
+
getMetaItemDescriptors(queryParams?: {
|
|
205
|
+
parentId?: string;
|
|
206
|
+
}, options?: O): RestResponse<{
|
|
207
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
208
|
+
}>;
|
|
209
|
+
/**
|
|
210
|
+
* HTTP GET /model/valueDescriptors
|
|
211
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
212
|
+
*/
|
|
213
|
+
getValueDescriptors(queryParams?: {
|
|
214
|
+
parentId?: string;
|
|
215
|
+
}, options?: O): RestResponse<{
|
|
216
|
+
[index: string]: Model.ValueDescriptor;
|
|
217
|
+
}>;
|
|
218
|
+
}
|
|
12
219
|
export declare class StatusResourceClient<O> {
|
|
13
220
|
protected httpClient: HttpClient<O>;
|
|
14
221
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -27,6 +234,36 @@ export declare class StatusResourceClient<O> {
|
|
|
27
234
|
[index: string]: any;
|
|
28
235
|
}>;
|
|
29
236
|
}
|
|
237
|
+
export declare class MapResourceClient<O> {
|
|
238
|
+
protected httpClient: HttpClient<O>;
|
|
239
|
+
constructor(httpClient: HttpClient<O>);
|
|
240
|
+
/**
|
|
241
|
+
* HTTP GET /map
|
|
242
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
243
|
+
*/
|
|
244
|
+
getSettings(options?: O): RestResponse<{
|
|
245
|
+
[id: string]: unknown;
|
|
246
|
+
}>;
|
|
247
|
+
/**
|
|
248
|
+
* HTTP PUT /map
|
|
249
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
250
|
+
*/
|
|
251
|
+
saveSettings(mapConfig: {
|
|
252
|
+
[index: string]: Model.MapRealmConfig;
|
|
253
|
+
}, options?: O): RestResponse<any>;
|
|
254
|
+
/**
|
|
255
|
+
* HTTP GET /map/js
|
|
256
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
257
|
+
*/
|
|
258
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
259
|
+
[id: string]: unknown;
|
|
260
|
+
}>;
|
|
261
|
+
/**
|
|
262
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
263
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
264
|
+
*/
|
|
265
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
266
|
+
}
|
|
30
267
|
export declare class UserResourceClient<O> {
|
|
31
268
|
protected httpClient: HttpClient<O>;
|
|
32
269
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -177,31 +414,24 @@ export declare class AgentResourceClient<O> {
|
|
|
177
414
|
realm?: string;
|
|
178
415
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
179
416
|
}
|
|
180
|
-
export declare class
|
|
417
|
+
export declare class AppResourceClient<O> {
|
|
181
418
|
protected httpClient: HttpClient<O>;
|
|
182
419
|
constructor(httpClient: HttpClient<O>);
|
|
183
420
|
/**
|
|
184
|
-
* HTTP GET /
|
|
185
|
-
* Java method: org.openremote.model.
|
|
421
|
+
* HTTP GET /apps
|
|
422
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
186
423
|
*/
|
|
187
|
-
|
|
424
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
188
425
|
/**
|
|
189
|
-
* HTTP
|
|
190
|
-
* Java method: org.openremote.model.
|
|
426
|
+
* HTTP GET /apps/consoleConfig
|
|
427
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
191
428
|
*/
|
|
192
|
-
|
|
429
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
193
430
|
/**
|
|
194
|
-
* HTTP
|
|
195
|
-
* Java method: org.openremote.model.
|
|
431
|
+
* HTTP GET /apps/info
|
|
432
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
196
433
|
*/
|
|
197
|
-
|
|
198
|
-
path?: string;
|
|
199
|
-
}, options?: O): RestResponse<string>;
|
|
200
|
-
/**
|
|
201
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
202
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
203
|
-
*/
|
|
204
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
434
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
205
435
|
}
|
|
206
436
|
export declare class RulesResourceClient<O> {
|
|
207
437
|
protected httpClient: HttpClient<O>;
|
|
@@ -345,157 +575,161 @@ export declare class DashboardResourceClient<O> {
|
|
|
345
575
|
*/
|
|
346
576
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
347
577
|
}
|
|
348
|
-
export declare class
|
|
578
|
+
export declare class FlowResourceClient<O> {
|
|
349
579
|
protected httpClient: HttpClient<O>;
|
|
350
580
|
constructor(httpClient: HttpClient<O>);
|
|
351
581
|
/**
|
|
352
|
-
* HTTP
|
|
353
|
-
* Java method: org.openremote.model.
|
|
354
|
-
*/
|
|
355
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
356
|
-
/**
|
|
357
|
-
* HTTP DELETE /asset
|
|
358
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
359
|
-
*/
|
|
360
|
-
delete(queryParams?: {
|
|
361
|
-
assetId?: string[];
|
|
362
|
-
}, options?: O): RestResponse<void>;
|
|
363
|
-
/**
|
|
364
|
-
* HTTP PUT /asset/attributes
|
|
365
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
366
|
-
*/
|
|
367
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
368
|
-
/**
|
|
369
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
370
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
582
|
+
* HTTP GET /flow
|
|
583
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
371
584
|
*/
|
|
372
|
-
|
|
585
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
373
586
|
/**
|
|
374
|
-
* HTTP
|
|
375
|
-
* Java method: org.openremote.model.
|
|
587
|
+
* HTTP GET /flow/{name}
|
|
588
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
376
589
|
*/
|
|
377
|
-
|
|
378
|
-
assetIds?: string[];
|
|
379
|
-
}, options?: O): RestResponse<void>;
|
|
590
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
380
591
|
/**
|
|
381
|
-
* HTTP GET /
|
|
382
|
-
* Java method: org.openremote.model.
|
|
592
|
+
* HTTP GET /flow/{type}
|
|
593
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
383
594
|
*/
|
|
384
|
-
|
|
595
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
596
|
+
}
|
|
597
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
598
|
+
protected httpClient: HttpClient<O>;
|
|
599
|
+
constructor(httpClient: HttpClient<O>);
|
|
385
600
|
/**
|
|
386
|
-
* HTTP POST /asset/
|
|
387
|
-
* Java method: org.openremote.model.
|
|
601
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
602
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
388
603
|
*/
|
|
389
|
-
|
|
604
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
390
605
|
/**
|
|
391
|
-
* HTTP
|
|
392
|
-
* Java method: org.openremote.model.
|
|
606
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
607
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
393
608
|
*/
|
|
394
|
-
|
|
609
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
610
|
+
}
|
|
611
|
+
export declare class NotificationResourceClient<O> {
|
|
612
|
+
protected httpClient: HttpClient<O>;
|
|
613
|
+
constructor(httpClient: HttpClient<O>);
|
|
395
614
|
/**
|
|
396
|
-
* HTTP
|
|
397
|
-
* Java method: org.openremote.model.
|
|
615
|
+
* HTTP GET /notification
|
|
616
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
398
617
|
*/
|
|
399
|
-
|
|
618
|
+
getNotifications(queryParams?: {
|
|
619
|
+
id?: number;
|
|
620
|
+
type?: string;
|
|
621
|
+
from?: number;
|
|
622
|
+
to?: number;
|
|
623
|
+
realmId?: string;
|
|
624
|
+
userId?: string;
|
|
625
|
+
assetId?: string;
|
|
626
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
400
627
|
/**
|
|
401
|
-
* HTTP
|
|
402
|
-
* Java method: org.openremote.model.
|
|
628
|
+
* HTTP DELETE /notification
|
|
629
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
403
630
|
*/
|
|
404
|
-
|
|
405
|
-
|
|
631
|
+
removeNotifications(queryParams?: {
|
|
632
|
+
id?: number;
|
|
633
|
+
type?: string;
|
|
634
|
+
from?: number;
|
|
635
|
+
to?: number;
|
|
636
|
+
realmId?: string;
|
|
406
637
|
userId?: string;
|
|
407
638
|
assetId?: string;
|
|
408
|
-
}, options?: O): RestResponse<
|
|
639
|
+
}, options?: O): RestResponse<void>;
|
|
409
640
|
/**
|
|
410
|
-
* HTTP POST /
|
|
411
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP POST /notification/alert
|
|
642
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
412
643
|
*/
|
|
413
|
-
|
|
644
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
414
645
|
/**
|
|
415
|
-
* HTTP DELETE /
|
|
416
|
-
* Java method: org.openremote.model.
|
|
646
|
+
* HTTP DELETE /notification/{notificationId}
|
|
647
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
417
648
|
*/
|
|
418
|
-
|
|
649
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
419
650
|
/**
|
|
420
|
-
* HTTP
|
|
421
|
-
* Java method: org.openremote.model.
|
|
651
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
652
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
422
653
|
*/
|
|
423
|
-
|
|
654
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
655
|
+
targetId?: string;
|
|
656
|
+
}, options?: O): RestResponse<void>;
|
|
424
657
|
/**
|
|
425
|
-
* HTTP
|
|
426
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
659
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
427
660
|
*/
|
|
428
|
-
|
|
661
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
662
|
+
targetId?: string;
|
|
663
|
+
}, options?: O): RestResponse<void>;
|
|
664
|
+
}
|
|
665
|
+
export declare class ProvisioningResourceClient<O> {
|
|
666
|
+
protected httpClient: HttpClient<O>;
|
|
667
|
+
constructor(httpClient: HttpClient<O>);
|
|
429
668
|
/**
|
|
430
|
-
* HTTP
|
|
431
|
-
* Java method: org.openremote.model.
|
|
669
|
+
* HTTP POST /provisioning
|
|
670
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
432
671
|
*/
|
|
433
|
-
|
|
672
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
434
673
|
/**
|
|
435
|
-
* HTTP
|
|
436
|
-
* Java method: org.openremote.model.
|
|
674
|
+
* HTTP GET /provisioning
|
|
675
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
437
676
|
*/
|
|
438
|
-
|
|
677
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
439
678
|
/**
|
|
440
|
-
* HTTP
|
|
441
|
-
* Java method: org.openremote.model.
|
|
679
|
+
* HTTP DELETE /provisioning/{id}
|
|
680
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
442
681
|
*/
|
|
443
|
-
|
|
682
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
444
683
|
/**
|
|
445
|
-
* HTTP PUT /
|
|
446
|
-
* Java method: org.openremote.model.
|
|
684
|
+
* HTTP PUT /provisioning/{id}
|
|
685
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
447
686
|
*/
|
|
448
|
-
|
|
449
|
-
assetIds?: string[];
|
|
450
|
-
}, options?: O): RestResponse<void>;
|
|
687
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
451
688
|
}
|
|
452
|
-
export declare class
|
|
689
|
+
export declare class GatewayClientResourceClient<O> {
|
|
453
690
|
protected httpClient: HttpClient<O>;
|
|
454
691
|
constructor(httpClient: HttpClient<O>);
|
|
455
692
|
/**
|
|
456
|
-
* HTTP
|
|
457
|
-
* Java method: org.openremote.model.
|
|
693
|
+
* HTTP DELETE /gateway/connection
|
|
694
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
458
695
|
*/
|
|
459
|
-
|
|
696
|
+
deleteConnections(queryParams?: {
|
|
697
|
+
realm?: string[];
|
|
698
|
+
}, options?: O): RestResponse<void>;
|
|
460
699
|
/**
|
|
461
|
-
* HTTP GET /
|
|
462
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* HTTP GET /gateway/connection
|
|
701
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
463
702
|
*/
|
|
464
|
-
|
|
703
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
465
704
|
/**
|
|
466
|
-
* HTTP
|
|
467
|
-
* Java method: org.openremote.model.
|
|
705
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
706
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
468
707
|
*/
|
|
469
|
-
|
|
708
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
470
709
|
/**
|
|
471
|
-
* HTTP
|
|
472
|
-
* Java method: org.openremote.model.
|
|
710
|
+
* HTTP GET /gateway/connection/{realm}
|
|
711
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
473
712
|
*/
|
|
474
|
-
|
|
713
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
475
714
|
/**
|
|
476
|
-
* HTTP
|
|
477
|
-
* Java method: org.openremote.model.
|
|
715
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
716
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
478
717
|
*/
|
|
479
|
-
|
|
718
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
480
719
|
/**
|
|
481
|
-
* HTTP
|
|
482
|
-
* Java method: org.openremote.model.
|
|
720
|
+
* HTTP GET /gateway/status/{realm}
|
|
721
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
483
722
|
*/
|
|
484
|
-
|
|
723
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
485
724
|
}
|
|
486
|
-
export declare class
|
|
725
|
+
export declare class ConsoleResourceClient<O> {
|
|
487
726
|
protected httpClient: HttpClient<O>;
|
|
488
727
|
constructor(httpClient: HttpClient<O>);
|
|
489
728
|
/**
|
|
490
|
-
* HTTP POST /
|
|
491
|
-
* Java method: org.openremote.model.
|
|
492
|
-
*/
|
|
493
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
494
|
-
/**
|
|
495
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
496
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
729
|
+
* HTTP POST /console/register
|
|
730
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
497
731
|
*/
|
|
498
|
-
|
|
732
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
499
733
|
}
|
|
500
734
|
export declare class AlarmResourceClient<O> {
|
|
501
735
|
protected httpClient: HttpClient<O>;
|
|
@@ -550,173 +784,65 @@ export declare class AlarmResourceClient<O> {
|
|
|
550
784
|
realm?: string;
|
|
551
785
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
552
786
|
}
|
|
553
|
-
export declare class
|
|
787
|
+
export declare class ConfigurationResourceClient<O> {
|
|
554
788
|
protected httpClient: HttpClient<O>;
|
|
555
789
|
constructor(httpClient: HttpClient<O>);
|
|
556
790
|
/**
|
|
557
|
-
* HTTP
|
|
558
|
-
* Java method: org.openremote.model.
|
|
791
|
+
* HTTP GET /configuration/manager
|
|
792
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
559
793
|
*/
|
|
560
|
-
|
|
794
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
561
795
|
/**
|
|
562
|
-
* HTTP
|
|
563
|
-
* Java method: org.openremote.model.
|
|
796
|
+
* HTTP PUT /configuration/manager
|
|
797
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
564
798
|
*/
|
|
565
|
-
|
|
799
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
566
800
|
/**
|
|
567
|
-
* HTTP
|
|
568
|
-
* Java method: org.openremote.model.
|
|
801
|
+
* HTTP POST /configuration/manager/file
|
|
802
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
569
803
|
*/
|
|
570
|
-
|
|
804
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
805
|
+
path?: string;
|
|
806
|
+
}, options?: O): RestResponse<string>;
|
|
571
807
|
/**
|
|
572
|
-
* HTTP
|
|
573
|
-
* Java method: org.openremote.model.
|
|
808
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
809
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
574
810
|
*/
|
|
575
|
-
|
|
811
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
576
812
|
}
|
|
577
|
-
export declare class
|
|
813
|
+
export declare class RealmResourceClient<O> {
|
|
578
814
|
protected httpClient: HttpClient<O>;
|
|
579
815
|
constructor(httpClient: HttpClient<O>);
|
|
580
816
|
/**
|
|
581
|
-
* HTTP
|
|
582
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP POST /realm
|
|
818
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
583
819
|
*/
|
|
584
|
-
|
|
585
|
-
id?: number;
|
|
586
|
-
type?: string;
|
|
587
|
-
from?: number;
|
|
588
|
-
to?: number;
|
|
589
|
-
realmId?: string;
|
|
590
|
-
userId?: string;
|
|
591
|
-
assetId?: string;
|
|
592
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
820
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
593
821
|
/**
|
|
594
|
-
* HTTP
|
|
595
|
-
* Java method: org.openremote.model.
|
|
822
|
+
* HTTP GET /realm
|
|
823
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
596
824
|
*/
|
|
597
|
-
|
|
598
|
-
id?: number;
|
|
599
|
-
type?: string;
|
|
600
|
-
from?: number;
|
|
601
|
-
to?: number;
|
|
602
|
-
realmId?: string;
|
|
603
|
-
userId?: string;
|
|
604
|
-
assetId?: string;
|
|
605
|
-
}, options?: O): RestResponse<void>;
|
|
606
|
-
/**
|
|
607
|
-
* HTTP POST /notification/alert
|
|
608
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
609
|
-
*/
|
|
610
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
611
|
-
/**
|
|
612
|
-
* HTTP DELETE /notification/{notificationId}
|
|
613
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
614
|
-
*/
|
|
615
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
616
|
-
/**
|
|
617
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
618
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
619
|
-
*/
|
|
620
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
621
|
-
targetId?: string;
|
|
622
|
-
}, options?: O): RestResponse<void>;
|
|
623
|
-
/**
|
|
624
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
625
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
626
|
-
*/
|
|
627
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
628
|
-
targetId?: string;
|
|
629
|
-
}, options?: O): RestResponse<void>;
|
|
630
|
-
}
|
|
631
|
-
export declare class ConsoleResourceClient<O> {
|
|
632
|
-
protected httpClient: HttpClient<O>;
|
|
633
|
-
constructor(httpClient: HttpClient<O>);
|
|
634
|
-
/**
|
|
635
|
-
* HTTP POST /console/register
|
|
636
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
637
|
-
*/
|
|
638
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
639
|
-
}
|
|
640
|
-
export declare class AppResourceClient<O> {
|
|
641
|
-
protected httpClient: HttpClient<O>;
|
|
642
|
-
constructor(httpClient: HttpClient<O>);
|
|
643
|
-
/**
|
|
644
|
-
* HTTP GET /apps
|
|
645
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
646
|
-
*/
|
|
647
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
648
|
-
/**
|
|
649
|
-
* HTTP GET /apps/consoleConfig
|
|
650
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
651
|
-
*/
|
|
652
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
653
|
-
/**
|
|
654
|
-
* HTTP GET /apps/info
|
|
655
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
656
|
-
*/
|
|
657
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
658
|
-
}
|
|
659
|
-
export declare class SyslogResourceClient<O> {
|
|
660
|
-
protected httpClient: HttpClient<O>;
|
|
661
|
-
constructor(httpClient: HttpClient<O>);
|
|
662
|
-
/**
|
|
663
|
-
* HTTP GET /syslog/config
|
|
664
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
665
|
-
*/
|
|
666
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
667
|
-
/**
|
|
668
|
-
* HTTP PUT /syslog/config
|
|
669
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
670
|
-
*/
|
|
671
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
672
|
-
/**
|
|
673
|
-
* HTTP DELETE /syslog/event
|
|
674
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
675
|
-
*/
|
|
676
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
677
|
-
/**
|
|
678
|
-
* HTTP GET /syslog/event
|
|
679
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
680
|
-
*/
|
|
681
|
-
getEvents(queryParams?: {
|
|
682
|
-
level?: Model.SyslogLevel;
|
|
683
|
-
per_page?: number;
|
|
684
|
-
page?: number;
|
|
685
|
-
from?: number;
|
|
686
|
-
to?: number;
|
|
687
|
-
category?: Model.SyslogCategory[];
|
|
688
|
-
subCategory?: string[];
|
|
689
|
-
}, options?: O): RestResponse<any>;
|
|
690
|
-
}
|
|
691
|
-
export declare class MapResourceClient<O> {
|
|
692
|
-
protected httpClient: HttpClient<O>;
|
|
693
|
-
constructor(httpClient: HttpClient<O>);
|
|
825
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
694
826
|
/**
|
|
695
|
-
* HTTP GET /
|
|
696
|
-
* Java method: org.openremote.model.
|
|
827
|
+
* HTTP GET /realm/accessible
|
|
828
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
697
829
|
*/
|
|
698
|
-
|
|
699
|
-
[id: string]: unknown;
|
|
700
|
-
}>;
|
|
830
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
701
831
|
/**
|
|
702
|
-
* HTTP
|
|
703
|
-
* Java method: org.openremote.model.
|
|
832
|
+
* HTTP DELETE /realm/{name}
|
|
833
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
704
834
|
*/
|
|
705
|
-
|
|
706
|
-
[index: string]: Model.MapRealmConfig;
|
|
707
|
-
}, options?: O): RestResponse<any>;
|
|
835
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
708
836
|
/**
|
|
709
|
-
* HTTP GET /
|
|
710
|
-
* Java method: org.openremote.model.
|
|
837
|
+
* HTTP GET /realm/{name}
|
|
838
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
711
839
|
*/
|
|
712
|
-
|
|
713
|
-
[id: string]: unknown;
|
|
714
|
-
}>;
|
|
840
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
715
841
|
/**
|
|
716
|
-
* HTTP
|
|
717
|
-
* Java method: org.openremote.model.
|
|
842
|
+
* HTTP PUT /realm/{name}
|
|
843
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
718
844
|
*/
|
|
719
|
-
|
|
845
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
720
846
|
}
|
|
721
847
|
export declare class GatewayServiceResourceClient<O> {
|
|
722
848
|
protected httpClient: HttpClient<O>;
|
|
@@ -747,177 +873,51 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
747
873
|
*/
|
|
748
874
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
749
875
|
}
|
|
750
|
-
export declare class FlowResourceClient<O> {
|
|
751
|
-
protected httpClient: HttpClient<O>;
|
|
752
|
-
constructor(httpClient: HttpClient<O>);
|
|
753
|
-
/**
|
|
754
|
-
* HTTP GET /flow
|
|
755
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
756
|
-
*/
|
|
757
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
758
|
-
/**
|
|
759
|
-
* HTTP GET /flow/{name}
|
|
760
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
761
|
-
*/
|
|
762
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
763
|
-
/**
|
|
764
|
-
* HTTP GET /flow/{type}
|
|
765
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
766
|
-
*/
|
|
767
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
768
|
-
}
|
|
769
|
-
export declare class GatewayClientResourceClient<O> {
|
|
770
|
-
protected httpClient: HttpClient<O>;
|
|
771
|
-
constructor(httpClient: HttpClient<O>);
|
|
772
|
-
/**
|
|
773
|
-
* HTTP DELETE /gateway/connection
|
|
774
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
775
|
-
*/
|
|
776
|
-
deleteConnections(queryParams?: {
|
|
777
|
-
realm?: string[];
|
|
778
|
-
}, options?: O): RestResponse<void>;
|
|
779
|
-
/**
|
|
780
|
-
* HTTP GET /gateway/connection
|
|
781
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
782
|
-
*/
|
|
783
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
784
|
-
/**
|
|
785
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
786
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
787
|
-
*/
|
|
788
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
789
|
-
/**
|
|
790
|
-
* HTTP GET /gateway/connection/{realm}
|
|
791
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
792
|
-
*/
|
|
793
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
794
|
-
/**
|
|
795
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
796
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
797
|
-
*/
|
|
798
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
799
|
-
/**
|
|
800
|
-
* HTTP GET /gateway/status/{realm}
|
|
801
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
802
|
-
*/
|
|
803
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
804
|
-
}
|
|
805
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
806
|
-
protected httpClient: HttpClient<O>;
|
|
807
|
-
constructor(httpClient: HttpClient<O>);
|
|
808
|
-
/**
|
|
809
|
-
* HTTP GET /asset/datapoint/export
|
|
810
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
811
|
-
*/
|
|
812
|
-
getDatapointExport(queryParams?: {
|
|
813
|
-
attributeRefs?: string;
|
|
814
|
-
fromTimestamp?: number;
|
|
815
|
-
toTimestamp?: number;
|
|
816
|
-
}, options?: O): RestResponse<any>;
|
|
817
|
-
/**
|
|
818
|
-
* HTTP GET /asset/datapoint/periods
|
|
819
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
820
|
-
*/
|
|
821
|
-
getDatapointPeriod(queryParams?: {
|
|
822
|
-
assetId?: string;
|
|
823
|
-
attributeName?: string;
|
|
824
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
825
|
-
/**
|
|
826
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
827
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
828
|
-
*/
|
|
829
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
830
|
-
}
|
|
831
|
-
export declare class AssetModelResourceClient<O> {
|
|
832
|
-
protected httpClient: HttpClient<O>;
|
|
833
|
-
constructor(httpClient: HttpClient<O>);
|
|
834
|
-
/**
|
|
835
|
-
* HTTP GET /model/assetDescriptors
|
|
836
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
837
|
-
*/
|
|
838
|
-
getAssetDescriptors(queryParams?: {
|
|
839
|
-
parentId?: string;
|
|
840
|
-
parentType?: string;
|
|
841
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
842
|
-
/**
|
|
843
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
844
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
845
|
-
*/
|
|
846
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
847
|
-
parentId?: string;
|
|
848
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
849
|
-
/**
|
|
850
|
-
* HTTP GET /model/assetInfos
|
|
851
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
852
|
-
*/
|
|
853
|
-
getAssetInfos(queryParams?: {
|
|
854
|
-
parentId?: string;
|
|
855
|
-
parentType?: string;
|
|
856
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP GET /model/metaItemDescriptors
|
|
859
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
860
|
-
*/
|
|
861
|
-
getMetaItemDescriptors(queryParams?: {
|
|
862
|
-
parentId?: string;
|
|
863
|
-
}, options?: O): RestResponse<{
|
|
864
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
865
|
-
}>;
|
|
866
|
-
/**
|
|
867
|
-
* HTTP GET /model/valueDescriptors
|
|
868
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
869
|
-
*/
|
|
870
|
-
getValueDescriptors(queryParams?: {
|
|
871
|
-
parentId?: string;
|
|
872
|
-
}, options?: O): RestResponse<{
|
|
873
|
-
[index: string]: Model.ValueDescriptor;
|
|
874
|
-
}>;
|
|
875
|
-
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
879
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
880
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
881
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
878
882
|
protected _statusResource: AxiosStatusResourceClient;
|
|
883
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
879
884
|
protected _userResource: AxiosUserResourceClient;
|
|
880
885
|
protected _agentResource: AxiosAgentResourceClient;
|
|
881
|
-
protected
|
|
886
|
+
protected _appResource: AxiosAppResourceClient;
|
|
882
887
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
883
888
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
884
|
-
protected
|
|
885
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
889
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
886
890
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
887
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
888
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
889
891
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
892
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
893
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
890
894
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
891
|
-
protected
|
|
892
|
-
protected
|
|
893
|
-
protected
|
|
895
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
896
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
897
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
894
898
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
895
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
896
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
897
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
898
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
901
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
902
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
903
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
900
904
|
get StatusResource(): AxiosStatusResourceClient;
|
|
905
|
+
get MapResource(): AxiosMapResourceClient;
|
|
901
906
|
get UserResource(): AxiosUserResourceClient;
|
|
902
907
|
get AgentResource(): AxiosAgentResourceClient;
|
|
903
|
-
get
|
|
908
|
+
get AppResource(): AxiosAppResourceClient;
|
|
904
909
|
get RulesResource(): AxiosRulesResourceClient;
|
|
905
910
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
906
|
-
get
|
|
907
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
911
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
908
912
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
909
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
910
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
911
913
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
914
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
915
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
912
916
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
913
|
-
get
|
|
914
|
-
get
|
|
915
|
-
get
|
|
917
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
918
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
919
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
916
920
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
917
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
918
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
919
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
920
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|