@openremote/rest 1.3.0-snapshot.20250120125703 → 1.3.0-snapshot.20250121104056
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 +456 -456
- 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,87 +9,111 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class GatewayClientResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP DELETE /gateway/connection
|
|
17
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
toTimestamp?: number;
|
|
23
|
-
}, options?: O): RestResponse<any>;
|
|
19
|
+
deleteConnections(queryParams?: {
|
|
20
|
+
realm?: any[];
|
|
21
|
+
}, options?: O): RestResponse<void>;
|
|
24
22
|
/**
|
|
25
|
-
* HTTP GET /
|
|
26
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /gateway/connection
|
|
24
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
27
25
|
*/
|
|
28
|
-
|
|
29
|
-
assetId?: any;
|
|
30
|
-
attributeName?: any;
|
|
31
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
26
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
32
27
|
/**
|
|
33
|
-
* HTTP
|
|
34
|
-
* Java method: org.openremote.model.
|
|
28
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
35
30
|
*/
|
|
36
|
-
|
|
37
|
-
}
|
|
38
|
-
export declare class StatusResourceClient<O> {
|
|
39
|
-
protected httpClient: HttpClient<O>;
|
|
40
|
-
constructor(httpClient: HttpClient<O>);
|
|
31
|
+
deleteConnection(realm: any, options?: O): RestResponse<void>;
|
|
41
32
|
/**
|
|
42
|
-
* HTTP GET /
|
|
43
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP GET /gateway/connection/{realm}
|
|
34
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
44
35
|
*/
|
|
45
|
-
|
|
46
|
-
[index: string]: any;
|
|
47
|
-
}>;
|
|
36
|
+
getConnection(realm: any, options?: O): RestResponse<Model.GatewayConnection>;
|
|
48
37
|
/**
|
|
49
|
-
* HTTP
|
|
50
|
-
* Java method: org.openremote.model.
|
|
38
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
39
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
51
40
|
*/
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
41
|
+
setConnection(realm: any, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
42
|
+
/**
|
|
43
|
+
* HTTP GET /gateway/status/{realm}
|
|
44
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
45
|
+
*/
|
|
46
|
+
getConnectionStatus(realm: any, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
55
47
|
}
|
|
56
|
-
export declare class
|
|
48
|
+
export declare class AgentResourceClient<O> {
|
|
57
49
|
protected httpClient: HttpClient<O>;
|
|
58
50
|
constructor(httpClient: HttpClient<O>);
|
|
59
51
|
/**
|
|
60
|
-
* HTTP
|
|
61
|
-
* Java method: org.openremote.model.
|
|
52
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
53
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
62
54
|
*/
|
|
63
|
-
|
|
55
|
+
doProtocolAssetDiscovery(agentId: any, queryParams?: {
|
|
56
|
+
realm?: any;
|
|
57
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
64
58
|
/**
|
|
65
|
-
* HTTP
|
|
66
|
-
* Java method: org.openremote.model.
|
|
59
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
60
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
67
61
|
*/
|
|
68
|
-
|
|
62
|
+
doProtocolAssetImport(agentId: any, fileInfo: Model.FileInfo, queryParams?: {
|
|
63
|
+
realm?: any;
|
|
64
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
69
65
|
/**
|
|
70
|
-
* HTTP GET /
|
|
71
|
-
* Java method: org.openremote.model.
|
|
66
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
67
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
72
68
|
*/
|
|
73
|
-
|
|
69
|
+
doProtocolInstanceDiscovery(agentType: any, queryParams?: {
|
|
70
|
+
parentId?: any;
|
|
71
|
+
realm?: any;
|
|
72
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
73
|
+
}
|
|
74
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
75
|
+
protected httpClient: HttpClient<O>;
|
|
76
|
+
constructor(httpClient: HttpClient<O>);
|
|
74
77
|
/**
|
|
75
|
-
* HTTP
|
|
76
|
-
* Java method: org.openremote.model.
|
|
78
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
79
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
77
80
|
*/
|
|
78
|
-
|
|
81
|
+
getPredictedDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
79
82
|
/**
|
|
80
|
-
* HTTP
|
|
81
|
-
* Java method: org.openremote.model.
|
|
83
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
84
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
82
85
|
*/
|
|
83
|
-
|
|
86
|
+
writePredictedDatapoints(assetId: any, attributeName: any, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
84
87
|
}
|
|
85
|
-
export declare class
|
|
88
|
+
export declare class MapResourceClient<O> {
|
|
86
89
|
protected httpClient: HttpClient<O>;
|
|
87
90
|
constructor(httpClient: HttpClient<O>);
|
|
88
91
|
/**
|
|
89
|
-
* HTTP
|
|
90
|
-
* Java method: org.openremote.model.
|
|
92
|
+
* HTTP GET /map
|
|
93
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
91
94
|
*/
|
|
92
|
-
|
|
95
|
+
getSettings(options?: O): RestResponse<{
|
|
96
|
+
[id: string]: any;
|
|
97
|
+
}>;
|
|
98
|
+
/**
|
|
99
|
+
* HTTP PUT /map
|
|
100
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
101
|
+
*/
|
|
102
|
+
saveSettings(mapConfig: {
|
|
103
|
+
[index: string]: Model.MapRealmConfig;
|
|
104
|
+
}, options?: O): RestResponse<any>;
|
|
105
|
+
/**
|
|
106
|
+
* HTTP GET /map/js
|
|
107
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
108
|
+
*/
|
|
109
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
110
|
+
[id: string]: any;
|
|
111
|
+
}>;
|
|
112
|
+
/**
|
|
113
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
114
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
115
|
+
*/
|
|
116
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
93
117
|
}
|
|
94
118
|
export declare class ProvisioningResourceClient<O> {
|
|
95
119
|
protected httpClient: HttpClient<O>;
|
|
@@ -115,103 +139,72 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
115
139
|
*/
|
|
116
140
|
updateProvisioningConfig(id: any, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
117
141
|
}
|
|
118
|
-
export declare class
|
|
142
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
119
143
|
protected httpClient: HttpClient<O>;
|
|
120
144
|
constructor(httpClient: HttpClient<O>);
|
|
121
145
|
/**
|
|
122
|
-
* HTTP GET /
|
|
123
|
-
* Java method: org.openremote.model.
|
|
146
|
+
* HTTP GET /asset/datapoint/export
|
|
147
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
124
148
|
*/
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
149
|
+
getDatapointExport(queryParams?: {
|
|
150
|
+
attributeRefs?: any;
|
|
151
|
+
fromTimestamp?: number;
|
|
152
|
+
toTimestamp?: number;
|
|
153
|
+
}, options?: O): RestResponse<any>;
|
|
128
154
|
/**
|
|
129
|
-
* HTTP
|
|
130
|
-
* Java method: org.openremote.model.
|
|
155
|
+
* HTTP GET /asset/datapoint/periods
|
|
156
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
131
157
|
*/
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
158
|
+
getDatapointPeriod(queryParams?: {
|
|
159
|
+
assetId?: any;
|
|
160
|
+
attributeName?: any;
|
|
161
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
135
162
|
/**
|
|
136
|
-
* HTTP
|
|
137
|
-
* Java method: org.openremote.model.
|
|
163
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
164
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
138
165
|
*/
|
|
139
|
-
|
|
140
|
-
parentId?: any;
|
|
141
|
-
realm?: any;
|
|
142
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
166
|
+
getDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
143
167
|
}
|
|
144
|
-
export declare class
|
|
168
|
+
export declare class ConsoleResourceClient<O> {
|
|
145
169
|
protected httpClient: HttpClient<O>;
|
|
146
170
|
constructor(httpClient: HttpClient<O>);
|
|
147
171
|
/**
|
|
148
|
-
* HTTP POST /
|
|
149
|
-
* Java method: org.openremote.model.
|
|
150
|
-
*/
|
|
151
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
152
|
-
assetIds?: any[];
|
|
153
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
154
|
-
/**
|
|
155
|
-
* HTTP GET /alarm
|
|
156
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
157
|
-
*/
|
|
158
|
-
getAlarms(queryParams?: {
|
|
159
|
-
realm?: any;
|
|
160
|
-
status?: Model.AlarmStatus;
|
|
161
|
-
assetId?: any;
|
|
162
|
-
assigneeId?: any;
|
|
163
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
164
|
-
/**
|
|
165
|
-
* HTTP DELETE /alarm
|
|
166
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
167
|
-
*/
|
|
168
|
-
removeAlarms(ids: any[], options?: O): RestResponse<void>;
|
|
169
|
-
/**
|
|
170
|
-
* HTTP PUT /alarm/assets
|
|
171
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
172
|
-
*/
|
|
173
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
174
|
-
/**
|
|
175
|
-
* HTTP GET /alarm/{alarmId}
|
|
176
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
177
|
-
*/
|
|
178
|
-
getAlarm(alarmId: any, options?: O): RestResponse<Model.SentAlarm>;
|
|
179
|
-
/**
|
|
180
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
181
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
182
|
-
*/
|
|
183
|
-
removeAlarm(alarmId: any, options?: O): RestResponse<void>;
|
|
184
|
-
/**
|
|
185
|
-
* HTTP PUT /alarm/{alarmId}
|
|
186
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
187
|
-
*/
|
|
188
|
-
updateAlarm(alarmId: any, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
189
|
-
/**
|
|
190
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
191
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
172
|
+
* HTTP POST /console/register
|
|
173
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
192
174
|
*/
|
|
193
|
-
|
|
194
|
-
realm?: any;
|
|
195
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
175
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
196
176
|
}
|
|
197
|
-
export declare class
|
|
177
|
+
export declare class SyslogResourceClient<O> {
|
|
198
178
|
protected httpClient: HttpClient<O>;
|
|
199
179
|
constructor(httpClient: HttpClient<O>);
|
|
200
180
|
/**
|
|
201
|
-
* HTTP GET /
|
|
202
|
-
* Java method: org.openremote.model.
|
|
181
|
+
* HTTP GET /syslog/config
|
|
182
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
203
183
|
*/
|
|
204
|
-
|
|
184
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
205
185
|
/**
|
|
206
|
-
* HTTP
|
|
207
|
-
* Java method: org.openremote.model.
|
|
186
|
+
* HTTP PUT /syslog/config
|
|
187
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
208
188
|
*/
|
|
209
|
-
|
|
189
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
210
190
|
/**
|
|
211
|
-
* HTTP
|
|
212
|
-
* Java method: org.openremote.model.
|
|
191
|
+
* HTTP DELETE /syslog/event
|
|
192
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
213
193
|
*/
|
|
214
|
-
|
|
194
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
195
|
+
/**
|
|
196
|
+
* HTTP GET /syslog/event
|
|
197
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
198
|
+
*/
|
|
199
|
+
getEvents(queryParams?: {
|
|
200
|
+
level?: Model.SyslogLevel;
|
|
201
|
+
per_page?: any;
|
|
202
|
+
page?: any;
|
|
203
|
+
from?: any;
|
|
204
|
+
to?: any;
|
|
205
|
+
category?: Model.SyslogCategory[];
|
|
206
|
+
subCategory?: any[];
|
|
207
|
+
}, options?: O): RestResponse<any>;
|
|
215
208
|
}
|
|
216
209
|
export declare class RulesResourceClient<O> {
|
|
217
210
|
protected httpClient: HttpClient<O>;
|
|
@@ -321,193 +314,226 @@ export declare class RulesResourceClient<O> {
|
|
|
321
314
|
*/
|
|
322
315
|
updateGlobalRuleset(id: any, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
323
316
|
}
|
|
324
|
-
export declare class
|
|
317
|
+
export declare class AssetModelResourceClient<O> {
|
|
325
318
|
protected httpClient: HttpClient<O>;
|
|
326
319
|
constructor(httpClient: HttpClient<O>);
|
|
327
320
|
/**
|
|
328
|
-
* HTTP GET /
|
|
329
|
-
* Java method: org.openremote.model.
|
|
321
|
+
* HTTP GET /model/assetDescriptors
|
|
322
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
330
323
|
*/
|
|
331
|
-
|
|
324
|
+
getAssetDescriptors(queryParams?: {
|
|
325
|
+
parentId?: any;
|
|
326
|
+
parentType?: any;
|
|
327
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
332
328
|
/**
|
|
333
|
-
* HTTP GET /
|
|
334
|
-
* Java method: org.openremote.model.
|
|
329
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
330
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
335
331
|
*/
|
|
336
|
-
|
|
332
|
+
getAssetInfo(assetType: any, queryParams?: {
|
|
333
|
+
parentId?: any;
|
|
334
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
337
335
|
/**
|
|
338
|
-
* HTTP GET /
|
|
339
|
-
* Java method: org.openremote.model.
|
|
336
|
+
* HTTP GET /model/assetInfos
|
|
337
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
340
338
|
*/
|
|
341
|
-
|
|
339
|
+
getAssetInfos(queryParams?: {
|
|
340
|
+
parentId?: any;
|
|
341
|
+
parentType?: any;
|
|
342
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
343
|
+
/**
|
|
344
|
+
* HTTP GET /model/metaItemDescriptors
|
|
345
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
346
|
+
*/
|
|
347
|
+
getMetaItemDescriptors(queryParams?: {
|
|
348
|
+
parentId?: any;
|
|
349
|
+
}, options?: O): RestResponse<{
|
|
350
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
351
|
+
}>;
|
|
352
|
+
/**
|
|
353
|
+
* HTTP GET /model/valueDescriptors
|
|
354
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
355
|
+
*/
|
|
356
|
+
getValueDescriptors(queryParams?: {
|
|
357
|
+
parentId?: any;
|
|
358
|
+
}, options?: O): RestResponse<{
|
|
359
|
+
[index: string]: Model.ValueDescriptor;
|
|
360
|
+
}>;
|
|
342
361
|
}
|
|
343
|
-
export declare class
|
|
362
|
+
export declare class AssetResourceClient<O> {
|
|
344
363
|
protected httpClient: HttpClient<O>;
|
|
345
364
|
constructor(httpClient: HttpClient<O>);
|
|
346
365
|
/**
|
|
347
|
-
* HTTP
|
|
348
|
-
* Java method: org.openremote.model.
|
|
366
|
+
* HTTP POST /asset
|
|
367
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
349
368
|
*/
|
|
350
|
-
|
|
351
|
-
|
|
369
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
370
|
+
/**
|
|
371
|
+
* HTTP DELETE /asset
|
|
372
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
373
|
+
*/
|
|
374
|
+
delete(queryParams?: {
|
|
375
|
+
assetId?: any[];
|
|
352
376
|
}, options?: O): RestResponse<void>;
|
|
353
377
|
/**
|
|
354
|
-
* HTTP
|
|
355
|
-
* Java method: org.openremote.model.
|
|
378
|
+
* HTTP PUT /asset/attributes
|
|
379
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
356
380
|
*/
|
|
357
|
-
|
|
381
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
358
382
|
/**
|
|
359
|
-
* HTTP
|
|
360
|
-
* Java method: org.openremote.model.
|
|
383
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
384
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
361
385
|
*/
|
|
362
|
-
|
|
386
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
363
387
|
/**
|
|
364
|
-
* HTTP
|
|
365
|
-
* Java method: org.openremote.model.
|
|
388
|
+
* HTTP DELETE /asset/parent
|
|
389
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
366
390
|
*/
|
|
367
|
-
|
|
391
|
+
updateNoneParent(queryParams?: {
|
|
392
|
+
assetIds?: any[];
|
|
393
|
+
}, options?: O): RestResponse<void>;
|
|
368
394
|
/**
|
|
369
|
-
* HTTP
|
|
370
|
-
* Java method: org.openremote.model.
|
|
395
|
+
* HTTP GET /asset/partial/{assetId}
|
|
396
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
371
397
|
*/
|
|
372
|
-
|
|
398
|
+
getPartial(assetId: any, options?: O): RestResponse<Model.Asset>;
|
|
373
399
|
/**
|
|
374
|
-
* HTTP
|
|
375
|
-
* Java method: org.openremote.model.
|
|
400
|
+
* HTTP POST /asset/query
|
|
401
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
376
402
|
*/
|
|
377
|
-
|
|
378
|
-
}
|
|
379
|
-
export declare class NotificationResourceClient<O> {
|
|
380
|
-
protected httpClient: HttpClient<O>;
|
|
381
|
-
constructor(httpClient: HttpClient<O>);
|
|
403
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
382
404
|
/**
|
|
383
|
-
* HTTP GET /
|
|
384
|
-
* Java method: org.openremote.model.
|
|
405
|
+
* HTTP GET /asset/user/current
|
|
406
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
385
407
|
*/
|
|
386
|
-
|
|
387
|
-
id?: any;
|
|
388
|
-
type?: any;
|
|
389
|
-
from?: any;
|
|
390
|
-
to?: any;
|
|
391
|
-
realmId?: any;
|
|
392
|
-
userId?: any;
|
|
393
|
-
assetId?: any;
|
|
394
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
408
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
395
409
|
/**
|
|
396
|
-
* HTTP
|
|
397
|
-
* Java method: org.openremote.model.
|
|
410
|
+
* HTTP POST /asset/user/link
|
|
411
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
398
412
|
*/
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
413
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
414
|
+
/**
|
|
415
|
+
* HTTP GET /asset/user/link
|
|
416
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
417
|
+
*/
|
|
418
|
+
getUserAssetLinks(queryParams?: {
|
|
419
|
+
realm?: any;
|
|
405
420
|
userId?: any;
|
|
406
421
|
assetId?: any;
|
|
407
|
-
}, options?: O): RestResponse<
|
|
422
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
408
423
|
/**
|
|
409
|
-
* HTTP POST /
|
|
410
|
-
* Java method: org.openremote.model.
|
|
424
|
+
* HTTP POST /asset/user/link/delete
|
|
425
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
411
426
|
*/
|
|
412
|
-
|
|
427
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
413
428
|
/**
|
|
414
|
-
* HTTP DELETE /
|
|
415
|
-
* Java method: org.openremote.model.
|
|
429
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
430
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
416
431
|
*/
|
|
417
|
-
|
|
432
|
+
deleteAllUserAssetLinks(realm: any, userId: any, options?: O): RestResponse<void>;
|
|
418
433
|
/**
|
|
419
|
-
* HTTP
|
|
420
|
-
* Java method: org.openremote.model.
|
|
434
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
435
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
421
436
|
*/
|
|
422
|
-
|
|
423
|
-
targetId?: any;
|
|
424
|
-
}, options?: O): RestResponse<void>;
|
|
437
|
+
deleteUserAssetLink(realm: any, userId: any, assetId: any, options?: O): RestResponse<void>;
|
|
425
438
|
/**
|
|
426
|
-
* HTTP
|
|
427
|
-
* Java method: org.openremote.model.
|
|
439
|
+
* HTTP GET /asset/{assetId}
|
|
440
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
428
441
|
*/
|
|
429
|
-
|
|
430
|
-
|
|
442
|
+
get(assetId: any, options?: O): RestResponse<Model.Asset>;
|
|
443
|
+
/**
|
|
444
|
+
* HTTP PUT /asset/{assetId}
|
|
445
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
446
|
+
*/
|
|
447
|
+
update(assetId: any, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
448
|
+
/**
|
|
449
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
450
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
451
|
+
*/
|
|
452
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: any, attributeName: any, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
453
|
+
/**
|
|
454
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
455
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
456
|
+
*/
|
|
457
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: any, attributeName: any, timestamp: any, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
458
|
+
/**
|
|
459
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
460
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
461
|
+
*/
|
|
462
|
+
updateParent(parentAssetId: any, queryParams?: {
|
|
463
|
+
assetIds?: any[];
|
|
431
464
|
}, options?: O): RestResponse<void>;
|
|
432
465
|
}
|
|
433
|
-
export declare class
|
|
466
|
+
export declare class AlarmResourceClient<O> {
|
|
434
467
|
protected httpClient: HttpClient<O>;
|
|
435
468
|
constructor(httpClient: HttpClient<O>);
|
|
436
469
|
/**
|
|
437
|
-
* HTTP
|
|
438
|
-
* Java method: org.openremote.model.
|
|
470
|
+
* HTTP POST /alarm
|
|
471
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
439
472
|
*/
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
473
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
474
|
+
assetIds?: any[];
|
|
475
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
444
476
|
/**
|
|
445
|
-
* HTTP GET /
|
|
446
|
-
* Java method: org.openremote.model.
|
|
477
|
+
* HTTP GET /alarm
|
|
478
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
447
479
|
*/
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
480
|
+
getAlarms(queryParams?: {
|
|
481
|
+
realm?: any;
|
|
482
|
+
status?: Model.AlarmStatus;
|
|
483
|
+
assetId?: any;
|
|
484
|
+
assigneeId?: any;
|
|
485
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
451
486
|
/**
|
|
452
|
-
* HTTP
|
|
453
|
-
* Java method: org.openremote.model.
|
|
487
|
+
* HTTP DELETE /alarm
|
|
488
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
454
489
|
*/
|
|
455
|
-
|
|
456
|
-
parentId?: any;
|
|
457
|
-
parentType?: any;
|
|
458
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
490
|
+
removeAlarms(ids: any[], options?: O): RestResponse<void>;
|
|
459
491
|
/**
|
|
460
|
-
* HTTP
|
|
461
|
-
* Java method: org.openremote.model.
|
|
492
|
+
* HTTP PUT /alarm/assets
|
|
493
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
462
494
|
*/
|
|
463
|
-
|
|
464
|
-
parentId?: any;
|
|
465
|
-
}, options?: O): RestResponse<{
|
|
466
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
467
|
-
}>;
|
|
495
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
468
496
|
/**
|
|
469
|
-
* HTTP GET /
|
|
470
|
-
* Java method: org.openremote.model.
|
|
497
|
+
* HTTP GET /alarm/{alarmId}
|
|
498
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
471
499
|
*/
|
|
472
|
-
|
|
473
|
-
parentId?: any;
|
|
474
|
-
}, options?: O): RestResponse<{
|
|
475
|
-
[index: string]: Model.ValueDescriptor;
|
|
476
|
-
}>;
|
|
477
|
-
}
|
|
478
|
-
export declare class DashboardResourceClient<O> {
|
|
479
|
-
protected httpClient: HttpClient<O>;
|
|
480
|
-
constructor(httpClient: HttpClient<O>);
|
|
500
|
+
getAlarm(alarmId: any, options?: O): RestResponse<Model.SentAlarm>;
|
|
481
501
|
/**
|
|
482
|
-
* HTTP
|
|
483
|
-
* Java method: org.openremote.model.
|
|
502
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
503
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
484
504
|
*/
|
|
485
|
-
|
|
505
|
+
removeAlarm(alarmId: any, options?: O): RestResponse<void>;
|
|
486
506
|
/**
|
|
487
|
-
* HTTP PUT /
|
|
488
|
-
* Java method: org.openremote.model.
|
|
507
|
+
* HTTP PUT /alarm/{alarmId}
|
|
508
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
489
509
|
*/
|
|
490
|
-
|
|
510
|
+
updateAlarm(alarmId: any, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
491
511
|
/**
|
|
492
|
-
* HTTP GET /
|
|
493
|
-
* Java method: org.openremote.model.
|
|
512
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
513
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
494
514
|
*/
|
|
495
|
-
|
|
515
|
+
getAssetLinks(alarmId: any, queryParams?: {
|
|
516
|
+
realm?: any;
|
|
517
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
518
|
+
}
|
|
519
|
+
export declare class FlowResourceClient<O> {
|
|
520
|
+
protected httpClient: HttpClient<O>;
|
|
521
|
+
constructor(httpClient: HttpClient<O>);
|
|
496
522
|
/**
|
|
497
|
-
* HTTP
|
|
498
|
-
* Java method: org.openremote.model.
|
|
523
|
+
* HTTP GET /flow
|
|
524
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
499
525
|
*/
|
|
500
|
-
|
|
526
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
501
527
|
/**
|
|
502
|
-
* HTTP
|
|
503
|
-
* Java method: org.openremote.model.
|
|
528
|
+
* HTTP GET /flow/{name}
|
|
529
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
504
530
|
*/
|
|
505
|
-
|
|
531
|
+
getNodeDefinition(name: any, options?: O): RestResponse<Model.Node>;
|
|
506
532
|
/**
|
|
507
|
-
* HTTP GET /
|
|
508
|
-
* Java method: org.openremote.model.
|
|
533
|
+
* HTTP GET /flow/{type}
|
|
534
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
509
535
|
*/
|
|
510
|
-
|
|
536
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
511
537
|
}
|
|
512
538
|
export declare class UserResourceClient<O> {
|
|
513
539
|
protected httpClient: HttpClient<O>;
|
|
@@ -633,94 +659,6 @@ export declare class UserResourceClient<O> {
|
|
|
633
659
|
*/
|
|
634
660
|
get(realm: any, userId: any, options?: O): RestResponse<Model.User>;
|
|
635
661
|
}
|
|
636
|
-
export declare class ConfigurationResourceClient<O> {
|
|
637
|
-
protected httpClient: HttpClient<O>;
|
|
638
|
-
constructor(httpClient: HttpClient<O>);
|
|
639
|
-
/**
|
|
640
|
-
* HTTP GET /configuration/manager
|
|
641
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
642
|
-
*/
|
|
643
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
644
|
-
/**
|
|
645
|
-
* HTTP PUT /configuration/manager
|
|
646
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
647
|
-
*/
|
|
648
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
649
|
-
/**
|
|
650
|
-
* HTTP POST /configuration/manager/file
|
|
651
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
652
|
-
*/
|
|
653
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
654
|
-
path?: any;
|
|
655
|
-
}, options?: O): RestResponse<any>;
|
|
656
|
-
/**
|
|
657
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
658
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
659
|
-
*/
|
|
660
|
-
getManagerConfigImage(filename: any, options?: O): RestResponse<any>;
|
|
661
|
-
}
|
|
662
|
-
export declare class SyslogResourceClient<O> {
|
|
663
|
-
protected httpClient: HttpClient<O>;
|
|
664
|
-
constructor(httpClient: HttpClient<O>);
|
|
665
|
-
/**
|
|
666
|
-
* HTTP GET /syslog/config
|
|
667
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
668
|
-
*/
|
|
669
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
670
|
-
/**
|
|
671
|
-
* HTTP PUT /syslog/config
|
|
672
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
673
|
-
*/
|
|
674
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
675
|
-
/**
|
|
676
|
-
* HTTP DELETE /syslog/event
|
|
677
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
678
|
-
*/
|
|
679
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
680
|
-
/**
|
|
681
|
-
* HTTP GET /syslog/event
|
|
682
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
683
|
-
*/
|
|
684
|
-
getEvents(queryParams?: {
|
|
685
|
-
level?: Model.SyslogLevel;
|
|
686
|
-
per_page?: any;
|
|
687
|
-
page?: any;
|
|
688
|
-
from?: any;
|
|
689
|
-
to?: any;
|
|
690
|
-
category?: Model.SyslogCategory[];
|
|
691
|
-
subCategory?: any[];
|
|
692
|
-
}, options?: O): RestResponse<any>;
|
|
693
|
-
}
|
|
694
|
-
export declare class MapResourceClient<O> {
|
|
695
|
-
protected httpClient: HttpClient<O>;
|
|
696
|
-
constructor(httpClient: HttpClient<O>);
|
|
697
|
-
/**
|
|
698
|
-
* HTTP GET /map
|
|
699
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
700
|
-
*/
|
|
701
|
-
getSettings(options?: O): RestResponse<{
|
|
702
|
-
[id: string]: any;
|
|
703
|
-
}>;
|
|
704
|
-
/**
|
|
705
|
-
* HTTP PUT /map
|
|
706
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
707
|
-
*/
|
|
708
|
-
saveSettings(mapConfig: {
|
|
709
|
-
[index: string]: Model.MapRealmConfig;
|
|
710
|
-
}, options?: O): RestResponse<any>;
|
|
711
|
-
/**
|
|
712
|
-
* HTTP GET /map/js
|
|
713
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
714
|
-
*/
|
|
715
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
716
|
-
[id: string]: any;
|
|
717
|
-
}>;
|
|
718
|
-
/**
|
|
719
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
720
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
721
|
-
*/
|
|
722
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
723
|
-
}
|
|
724
662
|
export declare class RealmResourceClient<O> {
|
|
725
663
|
protected httpClient: HttpClient<O>;
|
|
726
664
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -755,169 +693,231 @@ export declare class RealmResourceClient<O> {
|
|
|
755
693
|
*/
|
|
756
694
|
update(name: any, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
757
695
|
}
|
|
758
|
-
export declare class
|
|
696
|
+
export declare class DashboardResourceClient<O> {
|
|
759
697
|
protected httpClient: HttpClient<O>;
|
|
760
698
|
constructor(httpClient: HttpClient<O>);
|
|
761
699
|
/**
|
|
762
|
-
* HTTP POST /
|
|
763
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* HTTP POST /dashboard
|
|
701
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
764
702
|
*/
|
|
765
|
-
|
|
703
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
766
704
|
/**
|
|
767
|
-
* HTTP PUT /
|
|
768
|
-
* Java method: org.openremote.model.
|
|
705
|
+
* HTTP PUT /dashboard
|
|
706
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
769
707
|
*/
|
|
770
|
-
|
|
708
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
709
|
+
/**
|
|
710
|
+
* HTTP GET /dashboard/all/{realm}
|
|
711
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
712
|
+
*/
|
|
713
|
+
getAllRealmDashboards(realm: any, options?: O): RestResponse<Model.Dashboard[]>;
|
|
714
|
+
/**
|
|
715
|
+
* HTTP POST /dashboard/query
|
|
716
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
717
|
+
*/
|
|
718
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
719
|
+
/**
|
|
720
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
721
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
722
|
+
*/
|
|
723
|
+
delete(realm: any, dashboardId: any, options?: O): RestResponse<void>;
|
|
724
|
+
/**
|
|
725
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
726
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
727
|
+
*/
|
|
728
|
+
get(realm: any, dashboardId: any, options?: O): RestResponse<Model.Dashboard>;
|
|
771
729
|
}
|
|
772
|
-
export declare class
|
|
730
|
+
export declare class AppResourceClient<O> {
|
|
773
731
|
protected httpClient: HttpClient<O>;
|
|
774
732
|
constructor(httpClient: HttpClient<O>);
|
|
775
733
|
/**
|
|
776
|
-
* HTTP
|
|
777
|
-
* Java method: org.openremote.model.
|
|
734
|
+
* HTTP GET /apps
|
|
735
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
736
|
+
*/
|
|
737
|
+
getApps(options?: O): RestResponse<any[]>;
|
|
738
|
+
/**
|
|
739
|
+
* HTTP GET /apps/consoleConfig
|
|
740
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
778
741
|
*/
|
|
779
|
-
|
|
742
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
780
743
|
/**
|
|
781
|
-
* HTTP
|
|
782
|
-
* Java method: org.openremote.model.
|
|
744
|
+
* HTTP GET /apps/info
|
|
745
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
783
746
|
*/
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
747
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
748
|
+
}
|
|
749
|
+
export declare class StatusResourceClient<O> {
|
|
750
|
+
protected httpClient: HttpClient<O>;
|
|
751
|
+
constructor(httpClient: HttpClient<O>);
|
|
787
752
|
/**
|
|
788
|
-
* HTTP
|
|
789
|
-
* Java method: org.openremote.model.
|
|
753
|
+
* HTTP GET /health
|
|
754
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
790
755
|
*/
|
|
791
|
-
|
|
756
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
757
|
+
[index: string]: any;
|
|
758
|
+
}>;
|
|
792
759
|
/**
|
|
793
|
-
* HTTP
|
|
794
|
-
* Java method: org.openremote.model.
|
|
760
|
+
* HTTP GET /info
|
|
761
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
795
762
|
*/
|
|
796
|
-
|
|
763
|
+
getInfo(options?: O): RestResponse<{
|
|
764
|
+
[index: string]: any;
|
|
765
|
+
}>;
|
|
766
|
+
}
|
|
767
|
+
export declare class ConfigurationResourceClient<O> {
|
|
768
|
+
protected httpClient: HttpClient<O>;
|
|
769
|
+
constructor(httpClient: HttpClient<O>);
|
|
797
770
|
/**
|
|
798
|
-
* HTTP
|
|
799
|
-
* Java method: org.openremote.model.
|
|
771
|
+
* HTTP GET /configuration/manager
|
|
772
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
800
773
|
*/
|
|
801
|
-
|
|
802
|
-
assetIds?: any[];
|
|
803
|
-
}, options?: O): RestResponse<void>;
|
|
774
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
804
775
|
/**
|
|
805
|
-
* HTTP
|
|
806
|
-
* Java method: org.openremote.model.
|
|
776
|
+
* HTTP PUT /configuration/manager
|
|
777
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
807
778
|
*/
|
|
808
|
-
|
|
779
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
809
780
|
/**
|
|
810
|
-
* HTTP POST /
|
|
811
|
-
* Java method: org.openremote.model.
|
|
781
|
+
* HTTP POST /configuration/manager/file
|
|
782
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
812
783
|
*/
|
|
813
|
-
|
|
784
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
785
|
+
path?: any;
|
|
786
|
+
}, options?: O): RestResponse<any>;
|
|
814
787
|
/**
|
|
815
|
-
* HTTP GET /
|
|
816
|
-
* Java method: org.openremote.model.
|
|
788
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
789
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
817
790
|
*/
|
|
818
|
-
|
|
791
|
+
getManagerConfigImage(filename: any, options?: O): RestResponse<any>;
|
|
792
|
+
}
|
|
793
|
+
export declare class NotificationResourceClient<O> {
|
|
794
|
+
protected httpClient: HttpClient<O>;
|
|
795
|
+
constructor(httpClient: HttpClient<O>);
|
|
819
796
|
/**
|
|
820
|
-
* HTTP
|
|
821
|
-
* Java method: org.openremote.model.
|
|
797
|
+
* HTTP GET /notification
|
|
798
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
822
799
|
*/
|
|
823
|
-
|
|
800
|
+
getNotifications(queryParams?: {
|
|
801
|
+
id?: any;
|
|
802
|
+
type?: any;
|
|
803
|
+
from?: any;
|
|
804
|
+
to?: any;
|
|
805
|
+
realmId?: any;
|
|
806
|
+
userId?: any;
|
|
807
|
+
assetId?: any;
|
|
808
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
824
809
|
/**
|
|
825
|
-
* HTTP
|
|
826
|
-
* Java method: org.openremote.model.
|
|
810
|
+
* HTTP DELETE /notification
|
|
811
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
827
812
|
*/
|
|
828
|
-
|
|
829
|
-
|
|
813
|
+
removeNotifications(queryParams?: {
|
|
814
|
+
id?: any;
|
|
815
|
+
type?: any;
|
|
816
|
+
from?: any;
|
|
817
|
+
to?: any;
|
|
818
|
+
realmId?: any;
|
|
830
819
|
userId?: any;
|
|
831
820
|
assetId?: any;
|
|
832
|
-
}, options?: O): RestResponse<
|
|
821
|
+
}, options?: O): RestResponse<void>;
|
|
833
822
|
/**
|
|
834
|
-
* HTTP POST /
|
|
835
|
-
* Java method: org.openremote.model.
|
|
823
|
+
* HTTP POST /notification/alert
|
|
824
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
836
825
|
*/
|
|
837
|
-
|
|
826
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
838
827
|
/**
|
|
839
|
-
* HTTP DELETE /
|
|
840
|
-
* Java method: org.openremote.model.
|
|
828
|
+
* HTTP DELETE /notification/{notificationId}
|
|
829
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
841
830
|
*/
|
|
842
|
-
|
|
831
|
+
removeNotification(notificationId: any, options?: O): RestResponse<void>;
|
|
843
832
|
/**
|
|
844
|
-
* HTTP
|
|
845
|
-
* Java method: org.openremote.model.
|
|
833
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
834
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
846
835
|
*/
|
|
847
|
-
|
|
836
|
+
notificationAcknowledged(notificationId: any, acknowledgement: any, queryParams?: {
|
|
837
|
+
targetId?: any;
|
|
838
|
+
}, options?: O): RestResponse<void>;
|
|
848
839
|
/**
|
|
849
|
-
* HTTP
|
|
850
|
-
* Java method: org.openremote.model.
|
|
840
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
841
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
851
842
|
*/
|
|
852
|
-
|
|
843
|
+
notificationDelivered(notificationId: any, queryParams?: {
|
|
844
|
+
targetId?: any;
|
|
845
|
+
}, options?: O): RestResponse<void>;
|
|
846
|
+
}
|
|
847
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
848
|
+
protected httpClient: HttpClient<O>;
|
|
849
|
+
constructor(httpClient: HttpClient<O>);
|
|
853
850
|
/**
|
|
854
|
-
* HTTP
|
|
855
|
-
* Java method: org.openremote.model.
|
|
851
|
+
* HTTP POST /gateway/tunnel
|
|
852
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
856
853
|
*/
|
|
857
|
-
|
|
854
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
858
855
|
/**
|
|
859
|
-
* HTTP
|
|
860
|
-
* Java method: org.openremote.model.
|
|
856
|
+
* HTTP DELETE /gateway/tunnel
|
|
857
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
861
858
|
*/
|
|
862
|
-
|
|
859
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
863
860
|
/**
|
|
864
|
-
* HTTP
|
|
865
|
-
* Java method: org.openremote.model.
|
|
861
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
862
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
866
863
|
*/
|
|
867
|
-
|
|
864
|
+
getAllActiveTunnelInfos(realm: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
868
865
|
/**
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
866
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
867
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
871
868
|
*/
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
869
|
+
getGatewayActiveTunnelInfos(realm: any, id: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
870
|
+
/**
|
|
871
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
872
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
873
|
+
*/
|
|
874
|
+
getActiveTunnelInfo(realm: any, id: any, target: any, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
879
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
880
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
881
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
882
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
878
883
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
879
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
880
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
881
884
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
882
|
-
protected
|
|
883
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
884
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
885
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
885
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
886
886
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
887
|
-
protected _appResource: AxiosAppResourceClient;
|
|
888
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
889
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
890
887
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
891
|
-
protected
|
|
888
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
889
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
890
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
892
891
|
protected _userResource: AxiosUserResourceClient;
|
|
893
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
894
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
895
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
896
892
|
protected _realmResource: AxiosRealmResourceClient;
|
|
897
|
-
protected
|
|
898
|
-
protected
|
|
893
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
894
|
+
protected _appResource: AxiosAppResourceClient;
|
|
895
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
896
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
897
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
898
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
901
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
902
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
903
|
+
get MapResource(): AxiosMapResourceClient;
|
|
904
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
900
905
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
901
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
902
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
903
906
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
904
|
-
get
|
|
905
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
906
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
907
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
907
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
908
908
|
get RulesResource(): AxiosRulesResourceClient;
|
|
909
|
-
get AppResource(): AxiosAppResourceClient;
|
|
910
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
911
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
912
909
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
913
|
-
get
|
|
910
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
911
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
912
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
914
913
|
get UserResource(): AxiosUserResourceClient;
|
|
915
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
916
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
917
|
-
get MapResource(): AxiosMapResourceClient;
|
|
918
914
|
get RealmResource(): AxiosRealmResourceClient;
|
|
919
|
-
get
|
|
920
|
-
get
|
|
915
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
916
|
+
get AppResource(): AxiosAppResourceClient;
|
|
917
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
918
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
919
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
920
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
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 AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
940
|
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
952
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<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 AxiosNotificationResourceClient extends NotificationResourceClient<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
|
}
|