@openremote/rest 1.4.0-snapshot.20250226142611 → 1.4.0-snapshot.20250228134346
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 +445 -445
- 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,167 +9,262 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class ConsoleResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
20
|
-
[index: string]: any;
|
|
21
|
-
}>;
|
|
22
|
-
/**
|
|
23
|
-
* HTTP GET /info
|
|
24
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
16
|
+
* HTTP POST /console/register
|
|
17
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
25
18
|
*/
|
|
26
|
-
|
|
27
|
-
[index: string]: any;
|
|
28
|
-
}>;
|
|
19
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
29
20
|
}
|
|
30
|
-
export declare class
|
|
21
|
+
export declare class AssetResourceClient<O> {
|
|
31
22
|
protected httpClient: HttpClient<O>;
|
|
32
23
|
constructor(httpClient: HttpClient<O>);
|
|
33
24
|
/**
|
|
34
|
-
* HTTP POST /
|
|
35
|
-
* Java method: org.openremote.model.
|
|
25
|
+
* HTTP POST /asset
|
|
26
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
36
27
|
*/
|
|
37
|
-
|
|
28
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
29
|
+
/**
|
|
30
|
+
* HTTP DELETE /asset
|
|
31
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
32
|
+
*/
|
|
33
|
+
delete(queryParams?: {
|
|
34
|
+
assetId?: string[];
|
|
35
|
+
}, options?: O): RestResponse<void>;
|
|
36
|
+
/**
|
|
37
|
+
* HTTP PUT /asset/attributes
|
|
38
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
39
|
+
*/
|
|
40
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
41
|
+
/**
|
|
42
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
43
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
44
|
+
*/
|
|
45
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
46
|
+
/**
|
|
47
|
+
* HTTP DELETE /asset/parent
|
|
48
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
49
|
+
*/
|
|
50
|
+
updateNoneParent(queryParams?: {
|
|
38
51
|
assetIds?: string[];
|
|
39
|
-
}, options?: O): RestResponse<
|
|
52
|
+
}, options?: O): RestResponse<void>;
|
|
40
53
|
/**
|
|
41
|
-
* HTTP GET /
|
|
42
|
-
* Java method: org.openremote.model.
|
|
54
|
+
* HTTP GET /asset/partial/{assetId}
|
|
55
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
43
56
|
*/
|
|
44
|
-
|
|
57
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
58
|
+
/**
|
|
59
|
+
* HTTP POST /asset/query
|
|
60
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
61
|
+
*/
|
|
62
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
63
|
+
/**
|
|
64
|
+
* HTTP GET /asset/user/current
|
|
65
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
66
|
+
*/
|
|
67
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
68
|
+
/**
|
|
69
|
+
* HTTP POST /asset/user/link
|
|
70
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
71
|
+
*/
|
|
72
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
73
|
+
/**
|
|
74
|
+
* HTTP GET /asset/user/link
|
|
75
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
76
|
+
*/
|
|
77
|
+
getUserAssetLinks(queryParams?: {
|
|
45
78
|
realm?: string;
|
|
46
|
-
|
|
79
|
+
userId?: string;
|
|
47
80
|
assetId?: string;
|
|
48
|
-
|
|
49
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
81
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
50
82
|
/**
|
|
51
|
-
* HTTP
|
|
52
|
-
* Java method: org.openremote.model.
|
|
83
|
+
* HTTP POST /asset/user/link/delete
|
|
84
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
53
85
|
*/
|
|
54
|
-
|
|
86
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
55
87
|
/**
|
|
56
|
-
* HTTP
|
|
57
|
-
* Java method: org.openremote.model.
|
|
88
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
89
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
58
90
|
*/
|
|
59
|
-
|
|
91
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
60
92
|
/**
|
|
61
|
-
* HTTP
|
|
62
|
-
* Java method: org.openremote.model.
|
|
93
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
94
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
63
95
|
*/
|
|
64
|
-
|
|
96
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
65
97
|
/**
|
|
66
|
-
* HTTP
|
|
67
|
-
* Java method: org.openremote.model.
|
|
98
|
+
* HTTP GET /asset/{assetId}
|
|
99
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
68
100
|
*/
|
|
69
|
-
|
|
101
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
70
102
|
/**
|
|
71
|
-
* HTTP PUT /
|
|
72
|
-
* Java method: org.openremote.model.
|
|
103
|
+
* HTTP PUT /asset/{assetId}
|
|
104
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
73
105
|
*/
|
|
74
|
-
|
|
106
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
75
107
|
/**
|
|
76
|
-
* HTTP
|
|
77
|
-
* Java method: org.openremote.model.
|
|
108
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
109
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
78
110
|
*/
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
111
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
112
|
+
/**
|
|
113
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
114
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
115
|
+
*/
|
|
116
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
117
|
+
/**
|
|
118
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
119
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
120
|
+
*/
|
|
121
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
122
|
+
assetIds?: string[];
|
|
123
|
+
}, options?: O): RestResponse<void>;
|
|
82
124
|
}
|
|
83
|
-
export declare class
|
|
125
|
+
export declare class AppResourceClient<O> {
|
|
84
126
|
protected httpClient: HttpClient<O>;
|
|
85
127
|
constructor(httpClient: HttpClient<O>);
|
|
86
128
|
/**
|
|
87
|
-
* HTTP
|
|
88
|
-
* Java method: org.openremote.model.
|
|
129
|
+
* HTTP GET /apps
|
|
130
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
89
131
|
*/
|
|
90
|
-
|
|
132
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
91
133
|
/**
|
|
92
|
-
* HTTP
|
|
93
|
-
* Java method: org.openremote.model.
|
|
134
|
+
* HTTP GET /apps/consoleConfig
|
|
135
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
94
136
|
*/
|
|
95
|
-
|
|
137
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
138
|
+
/**
|
|
139
|
+
* HTTP GET /apps/info
|
|
140
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
141
|
+
*/
|
|
142
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
96
143
|
}
|
|
97
|
-
export declare class
|
|
144
|
+
export declare class AssetModelResourceClient<O> {
|
|
98
145
|
protected httpClient: HttpClient<O>;
|
|
99
146
|
constructor(httpClient: HttpClient<O>);
|
|
100
147
|
/**
|
|
101
|
-
* HTTP
|
|
102
|
-
* Java method: org.openremote.model.
|
|
148
|
+
* HTTP GET /model/assetDescriptors
|
|
149
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
103
150
|
*/
|
|
104
|
-
|
|
151
|
+
getAssetDescriptors(queryParams?: {
|
|
152
|
+
parentId?: string;
|
|
153
|
+
parentType?: string;
|
|
154
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
105
155
|
/**
|
|
106
|
-
* HTTP GET /
|
|
107
|
-
* Java method: org.openremote.model.
|
|
156
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
157
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
108
158
|
*/
|
|
109
|
-
|
|
159
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
160
|
+
parentId?: string;
|
|
161
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
110
162
|
/**
|
|
111
|
-
* HTTP
|
|
112
|
-
* Java method: org.openremote.model.
|
|
163
|
+
* HTTP GET /model/assetInfos
|
|
164
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
113
165
|
*/
|
|
114
|
-
|
|
166
|
+
getAssetInfos(queryParams?: {
|
|
167
|
+
parentId?: string;
|
|
168
|
+
parentType?: string;
|
|
169
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
115
170
|
/**
|
|
116
|
-
* HTTP
|
|
117
|
-
* Java method: org.openremote.model.
|
|
171
|
+
* HTTP GET /model/metaItemDescriptors
|
|
172
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
118
173
|
*/
|
|
119
|
-
|
|
174
|
+
getMetaItemDescriptors(queryParams?: {
|
|
175
|
+
parentId?: string;
|
|
176
|
+
}, options?: O): RestResponse<{
|
|
177
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
178
|
+
}>;
|
|
179
|
+
/**
|
|
180
|
+
* HTTP GET /model/valueDescriptors
|
|
181
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
182
|
+
*/
|
|
183
|
+
getValueDescriptors(queryParams?: {
|
|
184
|
+
parentId?: string;
|
|
185
|
+
}, options?: O): RestResponse<{
|
|
186
|
+
[index: string]: Model.ValueDescriptor;
|
|
187
|
+
}>;
|
|
120
188
|
}
|
|
121
|
-
export declare class
|
|
189
|
+
export declare class NotificationResourceClient<O> {
|
|
122
190
|
protected httpClient: HttpClient<O>;
|
|
123
191
|
constructor(httpClient: HttpClient<O>);
|
|
124
192
|
/**
|
|
125
|
-
* HTTP GET /
|
|
126
|
-
* Java method: org.openremote.model.
|
|
193
|
+
* HTTP GET /notification
|
|
194
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
127
195
|
*/
|
|
128
|
-
|
|
196
|
+
getNotifications(queryParams?: {
|
|
197
|
+
id?: number;
|
|
198
|
+
type?: string;
|
|
199
|
+
from?: number;
|
|
200
|
+
to?: number;
|
|
201
|
+
realmId?: string;
|
|
202
|
+
userId?: string;
|
|
203
|
+
assetId?: string;
|
|
204
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
129
205
|
/**
|
|
130
|
-
* HTTP
|
|
131
|
-
* Java method: org.openremote.model.
|
|
206
|
+
* HTTP DELETE /notification
|
|
207
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
132
208
|
*/
|
|
133
|
-
|
|
209
|
+
removeNotifications(queryParams?: {
|
|
210
|
+
id?: number;
|
|
211
|
+
type?: string;
|
|
212
|
+
from?: number;
|
|
213
|
+
to?: number;
|
|
214
|
+
realmId?: string;
|
|
215
|
+
userId?: string;
|
|
216
|
+
assetId?: string;
|
|
217
|
+
}, options?: O): RestResponse<void>;
|
|
134
218
|
/**
|
|
135
|
-
* HTTP
|
|
136
|
-
* Java method: org.openremote.model.
|
|
219
|
+
* HTTP POST /notification/alert
|
|
220
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
137
221
|
*/
|
|
138
|
-
|
|
139
|
-
}
|
|
140
|
-
export declare class RealmResourceClient<O> {
|
|
141
|
-
protected httpClient: HttpClient<O>;
|
|
142
|
-
constructor(httpClient: HttpClient<O>);
|
|
222
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
143
223
|
/**
|
|
144
|
-
* HTTP
|
|
145
|
-
* Java method: org.openremote.model.
|
|
224
|
+
* HTTP DELETE /notification/{notificationId}
|
|
225
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
146
226
|
*/
|
|
147
|
-
|
|
227
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
148
228
|
/**
|
|
149
|
-
* HTTP
|
|
150
|
-
* Java method: org.openremote.model.
|
|
229
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
230
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
151
231
|
*/
|
|
152
|
-
|
|
232
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
233
|
+
targetId?: string;
|
|
234
|
+
}, options?: O): RestResponse<void>;
|
|
153
235
|
/**
|
|
154
|
-
* HTTP
|
|
155
|
-
* Java method: org.openremote.model.
|
|
236
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
237
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
156
238
|
*/
|
|
157
|
-
|
|
239
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
240
|
+
targetId?: string;
|
|
241
|
+
}, options?: O): RestResponse<void>;
|
|
242
|
+
}
|
|
243
|
+
export declare class ConfigurationResourceClient<O> {
|
|
244
|
+
protected httpClient: HttpClient<O>;
|
|
245
|
+
constructor(httpClient: HttpClient<O>);
|
|
158
246
|
/**
|
|
159
|
-
* HTTP
|
|
160
|
-
* Java method: org.openremote.model.
|
|
247
|
+
* HTTP GET /configuration/manager
|
|
248
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
161
249
|
*/
|
|
162
|
-
|
|
250
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
163
251
|
/**
|
|
164
|
-
* HTTP
|
|
165
|
-
* Java method: org.openremote.model.
|
|
252
|
+
* HTTP PUT /configuration/manager
|
|
253
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
166
254
|
*/
|
|
167
|
-
|
|
255
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
168
256
|
/**
|
|
169
|
-
* HTTP
|
|
170
|
-
* Java method: org.openremote.model.
|
|
257
|
+
* HTTP POST /configuration/manager/file
|
|
258
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
171
259
|
*/
|
|
172
|
-
|
|
260
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
261
|
+
path?: string;
|
|
262
|
+
}, options?: O): RestResponse<string>;
|
|
263
|
+
/**
|
|
264
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
265
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
266
|
+
*/
|
|
267
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
173
268
|
}
|
|
174
269
|
export declare class DashboardResourceClient<O> {
|
|
175
270
|
protected httpClient: HttpClient<O>;
|
|
@@ -205,152 +300,72 @@ export declare class DashboardResourceClient<O> {
|
|
|
205
300
|
*/
|
|
206
301
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
207
302
|
}
|
|
208
|
-
export declare class
|
|
209
|
-
protected httpClient: HttpClient<O>;
|
|
210
|
-
constructor(httpClient: HttpClient<O>);
|
|
211
|
-
/**
|
|
212
|
-
* HTTP POST /console/register
|
|
213
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
214
|
-
*/
|
|
215
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
216
|
-
}
|
|
217
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
218
|
-
protected httpClient: HttpClient<O>;
|
|
219
|
-
constructor(httpClient: HttpClient<O>);
|
|
220
|
-
/**
|
|
221
|
-
* HTTP GET /asset/datapoint/export
|
|
222
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
223
|
-
*/
|
|
224
|
-
getDatapointExport(queryParams?: {
|
|
225
|
-
attributeRefs?: string;
|
|
226
|
-
fromTimestamp?: number;
|
|
227
|
-
toTimestamp?: number;
|
|
228
|
-
}, options?: O): RestResponse<any>;
|
|
229
|
-
/**
|
|
230
|
-
* HTTP GET /asset/datapoint/periods
|
|
231
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
232
|
-
*/
|
|
233
|
-
getDatapointPeriod(queryParams?: {
|
|
234
|
-
assetId?: string;
|
|
235
|
-
attributeName?: string;
|
|
236
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
237
|
-
/**
|
|
238
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
239
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
240
|
-
*/
|
|
241
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
242
|
-
}
|
|
243
|
-
export declare class AgentResourceClient<O> {
|
|
244
|
-
protected httpClient: HttpClient<O>;
|
|
245
|
-
constructor(httpClient: HttpClient<O>);
|
|
246
|
-
/**
|
|
247
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
248
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
249
|
-
*/
|
|
250
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
251
|
-
realm?: string;
|
|
252
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
253
|
-
/**
|
|
254
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
255
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
256
|
-
*/
|
|
257
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
258
|
-
realm?: string;
|
|
259
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
260
|
-
/**
|
|
261
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
262
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
263
|
-
*/
|
|
264
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
265
|
-
parentId?: string;
|
|
266
|
-
realm?: string;
|
|
267
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
268
|
-
}
|
|
269
|
-
export declare class SyslogResourceClient<O> {
|
|
303
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
270
304
|
protected httpClient: HttpClient<O>;
|
|
271
305
|
constructor(httpClient: HttpClient<O>);
|
|
272
306
|
/**
|
|
273
|
-
* HTTP
|
|
274
|
-
* Java method: org.openremote.model.
|
|
275
|
-
*/
|
|
276
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
277
|
-
/**
|
|
278
|
-
* HTTP PUT /syslog/config
|
|
279
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
280
|
-
*/
|
|
281
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
282
|
-
/**
|
|
283
|
-
* HTTP DELETE /syslog/event
|
|
284
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
307
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
308
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
285
309
|
*/
|
|
286
|
-
|
|
310
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
287
311
|
/**
|
|
288
|
-
* HTTP
|
|
289
|
-
* Java method: org.openremote.model.
|
|
290
|
-
*/
|
|
291
|
-
|
|
292
|
-
level?: Model.SyslogLevel;
|
|
293
|
-
per_page?: number;
|
|
294
|
-
page?: number;
|
|
295
|
-
from?: number;
|
|
296
|
-
to?: number;
|
|
297
|
-
category?: Model.SyslogCategory[];
|
|
298
|
-
subCategory?: string[];
|
|
299
|
-
}, options?: O): RestResponse<any>;
|
|
312
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
313
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
314
|
+
*/
|
|
315
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
300
316
|
}
|
|
301
|
-
export declare class
|
|
317
|
+
export declare class AlarmResourceClient<O> {
|
|
302
318
|
protected httpClient: HttpClient<O>;
|
|
303
319
|
constructor(httpClient: HttpClient<O>);
|
|
304
320
|
/**
|
|
305
|
-
* HTTP
|
|
306
|
-
* Java method: org.openremote.model.
|
|
321
|
+
* HTTP POST /alarm
|
|
322
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
307
323
|
*/
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
from?: number;
|
|
312
|
-
to?: number;
|
|
313
|
-
realmId?: string;
|
|
314
|
-
userId?: string;
|
|
315
|
-
assetId?: string;
|
|
316
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
324
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
325
|
+
assetIds?: string[];
|
|
326
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
317
327
|
/**
|
|
318
|
-
* HTTP
|
|
319
|
-
* Java method: org.openremote.model.
|
|
328
|
+
* HTTP GET /alarm
|
|
329
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
320
330
|
*/
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
from?: number;
|
|
325
|
-
to?: number;
|
|
326
|
-
realmId?: string;
|
|
327
|
-
userId?: string;
|
|
331
|
+
getAlarms(queryParams?: {
|
|
332
|
+
realm?: string;
|
|
333
|
+
status?: Model.AlarmStatus;
|
|
328
334
|
assetId?: string;
|
|
329
|
-
|
|
335
|
+
assigneeId?: string;
|
|
336
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
330
337
|
/**
|
|
331
|
-
* HTTP
|
|
332
|
-
* Java method: org.openremote.model.
|
|
338
|
+
* HTTP DELETE /alarm
|
|
339
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
333
340
|
*/
|
|
334
|
-
|
|
341
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
335
342
|
/**
|
|
336
|
-
* HTTP
|
|
337
|
-
* Java method: org.openremote.model.
|
|
343
|
+
* HTTP PUT /alarm/assets
|
|
344
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
338
345
|
*/
|
|
339
|
-
|
|
346
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
340
347
|
/**
|
|
341
|
-
* HTTP
|
|
342
|
-
* Java method: org.openremote.model.
|
|
348
|
+
* HTTP GET /alarm/{alarmId}
|
|
349
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
343
350
|
*/
|
|
344
|
-
|
|
345
|
-
targetId?: string;
|
|
346
|
-
}, options?: O): RestResponse<void>;
|
|
351
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
347
352
|
/**
|
|
348
|
-
* HTTP
|
|
349
|
-
* Java method: org.openremote.model.
|
|
353
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
354
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
350
355
|
*/
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
356
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
357
|
+
/**
|
|
358
|
+
* HTTP PUT /alarm/{alarmId}
|
|
359
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
360
|
+
*/
|
|
361
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
362
|
+
/**
|
|
363
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
364
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
365
|
+
*/
|
|
366
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
367
|
+
realm?: string;
|
|
368
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
354
369
|
}
|
|
355
370
|
export declare class GatewayServiceResourceClient<O> {
|
|
356
371
|
protected httpClient: HttpClient<O>;
|
|
@@ -381,87 +396,6 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
381
396
|
*/
|
|
382
397
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
383
398
|
}
|
|
384
|
-
export declare class GatewayClientResourceClient<O> {
|
|
385
|
-
protected httpClient: HttpClient<O>;
|
|
386
|
-
constructor(httpClient: HttpClient<O>);
|
|
387
|
-
/**
|
|
388
|
-
* HTTP DELETE /gateway/connection
|
|
389
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
390
|
-
*/
|
|
391
|
-
deleteConnections(queryParams?: {
|
|
392
|
-
realm?: string[];
|
|
393
|
-
}, options?: O): RestResponse<void>;
|
|
394
|
-
/**
|
|
395
|
-
* HTTP GET /gateway/connection
|
|
396
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
397
|
-
*/
|
|
398
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
399
|
-
/**
|
|
400
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
401
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
402
|
-
*/
|
|
403
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
404
|
-
/**
|
|
405
|
-
* HTTP GET /gateway/connection/{realm}
|
|
406
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
407
|
-
*/
|
|
408
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
409
|
-
/**
|
|
410
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
411
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
412
|
-
*/
|
|
413
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
414
|
-
/**
|
|
415
|
-
* HTTP GET /gateway/status/{realm}
|
|
416
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
417
|
-
*/
|
|
418
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
419
|
-
}
|
|
420
|
-
export declare class AssetModelResourceClient<O> {
|
|
421
|
-
protected httpClient: HttpClient<O>;
|
|
422
|
-
constructor(httpClient: HttpClient<O>);
|
|
423
|
-
/**
|
|
424
|
-
* HTTP GET /model/assetDescriptors
|
|
425
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
426
|
-
*/
|
|
427
|
-
getAssetDescriptors(queryParams?: {
|
|
428
|
-
parentId?: string;
|
|
429
|
-
parentType?: string;
|
|
430
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
431
|
-
/**
|
|
432
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
433
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
434
|
-
*/
|
|
435
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
436
|
-
parentId?: string;
|
|
437
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
438
|
-
/**
|
|
439
|
-
* HTTP GET /model/assetInfos
|
|
440
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
441
|
-
*/
|
|
442
|
-
getAssetInfos(queryParams?: {
|
|
443
|
-
parentId?: string;
|
|
444
|
-
parentType?: string;
|
|
445
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
446
|
-
/**
|
|
447
|
-
* HTTP GET /model/metaItemDescriptors
|
|
448
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
449
|
-
*/
|
|
450
|
-
getMetaItemDescriptors(queryParams?: {
|
|
451
|
-
parentId?: string;
|
|
452
|
-
}, options?: O): RestResponse<{
|
|
453
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
454
|
-
}>;
|
|
455
|
-
/**
|
|
456
|
-
* HTTP GET /model/valueDescriptors
|
|
457
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
458
|
-
*/
|
|
459
|
-
getValueDescriptors(queryParams?: {
|
|
460
|
-
parentId?: string;
|
|
461
|
-
}, options?: O): RestResponse<{
|
|
462
|
-
[index: string]: Model.ValueDescriptor;
|
|
463
|
-
}>;
|
|
464
|
-
}
|
|
465
399
|
export declare class UserResourceClient<O> {
|
|
466
400
|
protected httpClient: HttpClient<O>;
|
|
467
401
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -586,6 +520,57 @@ export declare class UserResourceClient<O> {
|
|
|
586
520
|
*/
|
|
587
521
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
588
522
|
}
|
|
523
|
+
export declare class FlowResourceClient<O> {
|
|
524
|
+
protected httpClient: HttpClient<O>;
|
|
525
|
+
constructor(httpClient: HttpClient<O>);
|
|
526
|
+
/**
|
|
527
|
+
* HTTP GET /flow
|
|
528
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
529
|
+
*/
|
|
530
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
531
|
+
/**
|
|
532
|
+
* HTTP GET /flow/{name}
|
|
533
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
534
|
+
*/
|
|
535
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
536
|
+
/**
|
|
537
|
+
* HTTP GET /flow/{type}
|
|
538
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
539
|
+
*/
|
|
540
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
541
|
+
}
|
|
542
|
+
export declare class SyslogResourceClient<O> {
|
|
543
|
+
protected httpClient: HttpClient<O>;
|
|
544
|
+
constructor(httpClient: HttpClient<O>);
|
|
545
|
+
/**
|
|
546
|
+
* HTTP GET /syslog/config
|
|
547
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
548
|
+
*/
|
|
549
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
550
|
+
/**
|
|
551
|
+
* HTTP PUT /syslog/config
|
|
552
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
553
|
+
*/
|
|
554
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
555
|
+
/**
|
|
556
|
+
* HTTP DELETE /syslog/event
|
|
557
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
558
|
+
*/
|
|
559
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
560
|
+
/**
|
|
561
|
+
* HTTP GET /syslog/event
|
|
562
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
563
|
+
*/
|
|
564
|
+
getEvents(queryParams?: {
|
|
565
|
+
level?: Model.SyslogLevel;
|
|
566
|
+
per_page?: number;
|
|
567
|
+
page?: number;
|
|
568
|
+
from?: number;
|
|
569
|
+
to?: number;
|
|
570
|
+
category?: Model.SyslogCategory[];
|
|
571
|
+
subCategory?: string[];
|
|
572
|
+
}, options?: O): RestResponse<any>;
|
|
573
|
+
}
|
|
589
574
|
export declare class RulesResourceClient<O> {
|
|
590
575
|
protected httpClient: HttpClient<O>;
|
|
591
576
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -724,200 +709,215 @@ export declare class MapResourceClient<O> {
|
|
|
724
709
|
*/
|
|
725
710
|
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
726
711
|
}
|
|
727
|
-
export declare class
|
|
712
|
+
export declare class ProvisioningResourceClient<O> {
|
|
728
713
|
protected httpClient: HttpClient<O>;
|
|
729
714
|
constructor(httpClient: HttpClient<O>);
|
|
730
715
|
/**
|
|
731
|
-
* HTTP POST /
|
|
732
|
-
* Java method: org.openremote.model.
|
|
716
|
+
* HTTP POST /provisioning
|
|
717
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
733
718
|
*/
|
|
734
|
-
|
|
719
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
735
720
|
/**
|
|
736
|
-
* HTTP
|
|
737
|
-
* Java method: org.openremote.model.
|
|
721
|
+
* HTTP GET /provisioning
|
|
722
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
738
723
|
*/
|
|
739
|
-
|
|
740
|
-
assetId?: string[];
|
|
741
|
-
}, options?: O): RestResponse<void>;
|
|
724
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
742
725
|
/**
|
|
743
|
-
* HTTP
|
|
744
|
-
* Java method: org.openremote.model.
|
|
726
|
+
* HTTP DELETE /provisioning/{id}
|
|
727
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
745
728
|
*/
|
|
746
|
-
|
|
729
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
747
730
|
/**
|
|
748
|
-
* HTTP PUT /
|
|
749
|
-
* Java method: org.openremote.model.
|
|
731
|
+
* HTTP PUT /provisioning/{id}
|
|
732
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
750
733
|
*/
|
|
751
|
-
|
|
734
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
735
|
+
}
|
|
736
|
+
export declare class StatusResourceClient<O> {
|
|
737
|
+
protected httpClient: HttpClient<O>;
|
|
738
|
+
constructor(httpClient: HttpClient<O>);
|
|
752
739
|
/**
|
|
753
|
-
* HTTP
|
|
754
|
-
* Java method: org.openremote.model.
|
|
740
|
+
* HTTP GET /health
|
|
741
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
755
742
|
*/
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
}
|
|
759
|
-
/**
|
|
760
|
-
* HTTP GET /
|
|
761
|
-
* Java method: org.openremote.model.
|
|
743
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
744
|
+
[index: string]: any;
|
|
745
|
+
}>;
|
|
746
|
+
/**
|
|
747
|
+
* HTTP GET /info
|
|
748
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
762
749
|
*/
|
|
763
|
-
|
|
750
|
+
getInfo(options?: O): RestResponse<{
|
|
751
|
+
[index: string]: any;
|
|
752
|
+
}>;
|
|
753
|
+
}
|
|
754
|
+
export declare class RealmResourceClient<O> {
|
|
755
|
+
protected httpClient: HttpClient<O>;
|
|
756
|
+
constructor(httpClient: HttpClient<O>);
|
|
764
757
|
/**
|
|
765
|
-
* HTTP POST /
|
|
766
|
-
* Java method: org.openremote.model.
|
|
758
|
+
* HTTP POST /realm
|
|
759
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
767
760
|
*/
|
|
768
|
-
|
|
761
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
769
762
|
/**
|
|
770
|
-
* HTTP GET /
|
|
771
|
-
* Java method: org.openremote.model.
|
|
763
|
+
* HTTP GET /realm
|
|
764
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
772
765
|
*/
|
|
773
|
-
|
|
766
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
774
767
|
/**
|
|
775
|
-
* HTTP
|
|
776
|
-
* Java method: org.openremote.model.
|
|
768
|
+
* HTTP GET /realm/accessible
|
|
769
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
777
770
|
*/
|
|
778
|
-
|
|
771
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
779
772
|
/**
|
|
780
|
-
* HTTP
|
|
781
|
-
* Java method: org.openremote.model.
|
|
773
|
+
* HTTP DELETE /realm/{name}
|
|
774
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
782
775
|
*/
|
|
783
|
-
|
|
784
|
-
realm?: string;
|
|
785
|
-
userId?: string;
|
|
786
|
-
assetId?: string;
|
|
787
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
776
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
788
777
|
/**
|
|
789
|
-
* HTTP
|
|
790
|
-
* Java method: org.openremote.model.
|
|
778
|
+
* HTTP GET /realm/{name}
|
|
779
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
791
780
|
*/
|
|
792
|
-
|
|
781
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
793
782
|
/**
|
|
794
|
-
* HTTP
|
|
795
|
-
* Java method: org.openremote.model.
|
|
783
|
+
* HTTP PUT /realm/{name}
|
|
784
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
796
785
|
*/
|
|
797
|
-
|
|
786
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
787
|
+
}
|
|
788
|
+
export declare class GatewayClientResourceClient<O> {
|
|
789
|
+
protected httpClient: HttpClient<O>;
|
|
790
|
+
constructor(httpClient: HttpClient<O>);
|
|
798
791
|
/**
|
|
799
|
-
* HTTP DELETE /
|
|
800
|
-
* Java method: org.openremote.model.
|
|
792
|
+
* HTTP DELETE /gateway/connection
|
|
793
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
801
794
|
*/
|
|
802
|
-
|
|
795
|
+
deleteConnections(queryParams?: {
|
|
796
|
+
realm?: string[];
|
|
797
|
+
}, options?: O): RestResponse<void>;
|
|
803
798
|
/**
|
|
804
|
-
* HTTP GET /
|
|
805
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP GET /gateway/connection
|
|
800
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
806
801
|
*/
|
|
807
|
-
|
|
802
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
808
803
|
/**
|
|
809
|
-
* HTTP
|
|
810
|
-
* Java method: org.openremote.model.
|
|
804
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
805
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
811
806
|
*/
|
|
812
|
-
|
|
807
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
813
808
|
/**
|
|
814
|
-
* HTTP
|
|
815
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP GET /gateway/connection/{realm}
|
|
810
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
816
811
|
*/
|
|
817
|
-
|
|
812
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
818
813
|
/**
|
|
819
|
-
* HTTP PUT /
|
|
820
|
-
* Java method: org.openremote.model.
|
|
814
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
815
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
821
816
|
*/
|
|
822
|
-
|
|
817
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
823
818
|
/**
|
|
824
|
-
* HTTP
|
|
825
|
-
* Java method: org.openremote.model.
|
|
819
|
+
* HTTP GET /gateway/status/{realm}
|
|
820
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
826
821
|
*/
|
|
827
|
-
|
|
828
|
-
assetIds?: string[];
|
|
829
|
-
}, options?: O): RestResponse<void>;
|
|
822
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
830
823
|
}
|
|
831
|
-
export declare class
|
|
824
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
832
825
|
protected httpClient: HttpClient<O>;
|
|
833
826
|
constructor(httpClient: HttpClient<O>);
|
|
834
827
|
/**
|
|
835
|
-
* HTTP GET /
|
|
836
|
-
* Java method: org.openremote.model.
|
|
837
|
-
*/
|
|
838
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
839
|
-
/**
|
|
840
|
-
* HTTP PUT /configuration/manager
|
|
841
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
828
|
+
* HTTP GET /asset/datapoint/export
|
|
829
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
842
830
|
*/
|
|
843
|
-
|
|
831
|
+
getDatapointExport(queryParams?: {
|
|
832
|
+
attributeRefs?: string;
|
|
833
|
+
fromTimestamp?: number;
|
|
834
|
+
toTimestamp?: number;
|
|
835
|
+
}, options?: O): RestResponse<any>;
|
|
844
836
|
/**
|
|
845
|
-
* HTTP
|
|
846
|
-
* Java method: org.openremote.model.
|
|
837
|
+
* HTTP GET /asset/datapoint/periods
|
|
838
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
847
839
|
*/
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
840
|
+
getDatapointPeriod(queryParams?: {
|
|
841
|
+
assetId?: string;
|
|
842
|
+
attributeName?: string;
|
|
843
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
851
844
|
/**
|
|
852
|
-
* HTTP
|
|
853
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
846
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
854
847
|
*/
|
|
855
|
-
|
|
848
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
856
849
|
}
|
|
857
|
-
export declare class
|
|
850
|
+
export declare class AgentResourceClient<O> {
|
|
858
851
|
protected httpClient: HttpClient<O>;
|
|
859
852
|
constructor(httpClient: HttpClient<O>);
|
|
860
853
|
/**
|
|
861
|
-
* HTTP GET /
|
|
862
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
855
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
863
856
|
*/
|
|
864
|
-
|
|
857
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
858
|
+
realm?: string;
|
|
859
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
865
860
|
/**
|
|
866
|
-
* HTTP
|
|
867
|
-
* Java method: org.openremote.model.
|
|
861
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
862
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
868
863
|
*/
|
|
869
|
-
|
|
864
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
865
|
+
realm?: string;
|
|
866
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
870
867
|
/**
|
|
871
|
-
* HTTP GET /
|
|
872
|
-
* Java method: org.openremote.model.
|
|
868
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
869
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
873
870
|
*/
|
|
874
|
-
|
|
871
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
872
|
+
parentId?: string;
|
|
873
|
+
realm?: string;
|
|
874
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
879
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
880
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
881
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
882
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
883
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
884
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
885
878
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
886
|
-
protected
|
|
887
|
-
protected
|
|
888
|
-
protected
|
|
879
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
880
|
+
protected _appResource: AxiosAppResourceClient;
|
|
881
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
889
882
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
883
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
884
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
885
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
886
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
890
887
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
891
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
892
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
893
888
|
protected _userResource: AxiosUserResourceClient;
|
|
889
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
890
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
894
891
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
895
892
|
protected _mapResource: AxiosMapResourceClient;
|
|
896
|
-
protected
|
|
897
|
-
protected
|
|
898
|
-
protected
|
|
893
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
894
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
895
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
896
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
897
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
898
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
901
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
902
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
903
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
904
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
905
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
906
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
907
900
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
908
|
-
get
|
|
909
|
-
get
|
|
910
|
-
get
|
|
901
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
902
|
+
get AppResource(): AxiosAppResourceClient;
|
|
903
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
911
904
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
905
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
906
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
907
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
908
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
912
909
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
913
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
914
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
915
910
|
get UserResource(): AxiosUserResourceClient;
|
|
911
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
912
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
916
913
|
get RulesResource(): AxiosRulesResourceClient;
|
|
917
914
|
get MapResource(): AxiosMapResourceClient;
|
|
918
|
-
get
|
|
919
|
-
get
|
|
920
|
-
get
|
|
915
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
916
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
917
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
918
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
919
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
920
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
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 AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<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 AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
946
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<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 AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|