@openremote/rest 1.12.0-snapshot.20251124122423 → 1.12.0-snapshot.20251125122444
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.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +615 -615
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +1 -1
package/lib/restclient.d.ts
CHANGED
|
@@ -9,23 +9,226 @@ 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
|
-
}>;
|
|
19
|
+
deleteConnections(queryParams?: {
|
|
20
|
+
realm?: string[];
|
|
21
|
+
}, options?: O): RestResponse<void>;
|
|
22
22
|
/**
|
|
23
|
-
* HTTP GET /
|
|
24
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /gateway/connection
|
|
24
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
25
25
|
*/
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
26
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
27
|
+
/**
|
|
28
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
30
|
+
*/
|
|
31
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
32
|
+
/**
|
|
33
|
+
* HTTP GET /gateway/connection/{realm}
|
|
34
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
35
|
+
*/
|
|
36
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
37
|
+
/**
|
|
38
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
39
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
40
|
+
*/
|
|
41
|
+
setConnection(realm: string, 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: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
47
|
+
}
|
|
48
|
+
export declare class ConfigurationResourceClient<O> {
|
|
49
|
+
protected httpClient: HttpClient<O>;
|
|
50
|
+
constructor(httpClient: HttpClient<O>);
|
|
51
|
+
/**
|
|
52
|
+
* HTTP GET /configuration/manager
|
|
53
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
54
|
+
*/
|
|
55
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
56
|
+
/**
|
|
57
|
+
* HTTP PUT /configuration/manager
|
|
58
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
59
|
+
*/
|
|
60
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
61
|
+
/**
|
|
62
|
+
* HTTP POST /configuration/manager/file
|
|
63
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
64
|
+
*/
|
|
65
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
66
|
+
path?: string;
|
|
67
|
+
}, options?: O): RestResponse<string>;
|
|
68
|
+
/**
|
|
69
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
70
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
71
|
+
*/
|
|
72
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
73
|
+
}
|
|
74
|
+
export declare class ProvisioningResourceClient<O> {
|
|
75
|
+
protected httpClient: HttpClient<O>;
|
|
76
|
+
constructor(httpClient: HttpClient<O>);
|
|
77
|
+
/**
|
|
78
|
+
* HTTP POST /provisioning
|
|
79
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
80
|
+
*/
|
|
81
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
82
|
+
/**
|
|
83
|
+
* HTTP GET /provisioning
|
|
84
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
85
|
+
*/
|
|
86
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
87
|
+
/**
|
|
88
|
+
* HTTP DELETE /provisioning/{id}
|
|
89
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
90
|
+
*/
|
|
91
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
92
|
+
/**
|
|
93
|
+
* HTTP PUT /provisioning/{id}
|
|
94
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
95
|
+
*/
|
|
96
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
97
|
+
}
|
|
98
|
+
export declare class NotificationResourceClient<O> {
|
|
99
|
+
protected httpClient: HttpClient<O>;
|
|
100
|
+
constructor(httpClient: HttpClient<O>);
|
|
101
|
+
/**
|
|
102
|
+
* HTTP GET /notification
|
|
103
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
104
|
+
*/
|
|
105
|
+
getNotifications(queryParams?: {
|
|
106
|
+
id?: number;
|
|
107
|
+
type?: string;
|
|
108
|
+
from?: number;
|
|
109
|
+
to?: number;
|
|
110
|
+
realmId?: string;
|
|
111
|
+
userId?: string;
|
|
112
|
+
assetId?: string;
|
|
113
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
114
|
+
/**
|
|
115
|
+
* HTTP DELETE /notification
|
|
116
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
117
|
+
*/
|
|
118
|
+
removeNotifications(queryParams?: {
|
|
119
|
+
id?: number;
|
|
120
|
+
type?: string;
|
|
121
|
+
from?: number;
|
|
122
|
+
to?: number;
|
|
123
|
+
realmId?: string;
|
|
124
|
+
userId?: string;
|
|
125
|
+
assetId?: string;
|
|
126
|
+
}, options?: O): RestResponse<void>;
|
|
127
|
+
/**
|
|
128
|
+
* HTTP POST /notification/alert
|
|
129
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
130
|
+
*/
|
|
131
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
132
|
+
/**
|
|
133
|
+
* HTTP DELETE /notification/{notificationId}
|
|
134
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
135
|
+
*/
|
|
136
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
137
|
+
/**
|
|
138
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
139
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
140
|
+
*/
|
|
141
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
142
|
+
targetId?: string;
|
|
143
|
+
}, options?: O): RestResponse<void>;
|
|
144
|
+
/**
|
|
145
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
146
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
147
|
+
*/
|
|
148
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
149
|
+
targetId?: string;
|
|
150
|
+
}, options?: O): RestResponse<void>;
|
|
151
|
+
}
|
|
152
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
153
|
+
protected httpClient: HttpClient<O>;
|
|
154
|
+
constructor(httpClient: HttpClient<O>);
|
|
155
|
+
/**
|
|
156
|
+
* Response code 200 - List of registered external services
|
|
157
|
+
* HTTP GET /service
|
|
158
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
159
|
+
*/
|
|
160
|
+
getServices(queryParams?: {
|
|
161
|
+
realm?: string;
|
|
162
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
163
|
+
/**
|
|
164
|
+
* Response code 200 - Service registered successfully
|
|
165
|
+
* Response code 400 - Invalid external service object
|
|
166
|
+
* Response code 409 - ExternalService instance already registered
|
|
167
|
+
* HTTP POST /service
|
|
168
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
169
|
+
*/
|
|
170
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
171
|
+
/**
|
|
172
|
+
* Response code 200 - List of registered external services
|
|
173
|
+
* HTTP GET /service/global
|
|
174
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
175
|
+
*/
|
|
176
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
177
|
+
/**
|
|
178
|
+
* Response code 200 - Service registered successfully
|
|
179
|
+
* Response code 400 - Invalid external service object
|
|
180
|
+
* Response code 409 - ExternalService instance already registered
|
|
181
|
+
* HTTP POST /service/global
|
|
182
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
183
|
+
*/
|
|
184
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
185
|
+
/**
|
|
186
|
+
* Response code 204 - Service deregistered successfully
|
|
187
|
+
* Response code 404 - Service instance not found
|
|
188
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
189
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
190
|
+
*/
|
|
191
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
192
|
+
/**
|
|
193
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
194
|
+
* Response code 404 - ExternalService not found
|
|
195
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
196
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
197
|
+
*/
|
|
198
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
199
|
+
/**
|
|
200
|
+
* Response code 204 - Heartbeat sent successfully
|
|
201
|
+
* Response code 404 - Service instance not found
|
|
202
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
203
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
204
|
+
*/
|
|
205
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
206
|
+
}
|
|
207
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
208
|
+
protected httpClient: HttpClient<O>;
|
|
209
|
+
constructor(httpClient: HttpClient<O>);
|
|
210
|
+
/**
|
|
211
|
+
* HTTP GET /asset/datapoint/export
|
|
212
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
213
|
+
*/
|
|
214
|
+
getDatapointExport(queryParams?: {
|
|
215
|
+
attributeRefs?: string;
|
|
216
|
+
fromTimestamp?: number;
|
|
217
|
+
toTimestamp?: number;
|
|
218
|
+
}, options?: O): RestResponse<any>;
|
|
219
|
+
/**
|
|
220
|
+
* HTTP GET /asset/datapoint/periods
|
|
221
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
222
|
+
*/
|
|
223
|
+
getDatapointPeriod(queryParams?: {
|
|
224
|
+
assetId?: string;
|
|
225
|
+
attributeName?: string;
|
|
226
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
227
|
+
/**
|
|
228
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
229
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
230
|
+
*/
|
|
231
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
29
232
|
}
|
|
30
233
|
export declare class RulesResourceClient<O> {
|
|
31
234
|
protected httpClient: HttpClient<O>;
|
|
@@ -135,183 +338,114 @@ export declare class RulesResourceClient<O> {
|
|
|
135
338
|
*/
|
|
136
339
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
137
340
|
}
|
|
138
|
-
export declare class
|
|
341
|
+
export declare class AssetResourceClient<O> {
|
|
139
342
|
protected httpClient: HttpClient<O>;
|
|
140
343
|
constructor(httpClient: HttpClient<O>);
|
|
141
344
|
/**
|
|
142
|
-
* HTTP
|
|
143
|
-
* Java method: org.openremote.model.
|
|
345
|
+
* HTTP POST /asset
|
|
346
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
144
347
|
*/
|
|
145
|
-
|
|
348
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
146
349
|
/**
|
|
147
|
-
* HTTP
|
|
148
|
-
* Java method: org.openremote.model.
|
|
350
|
+
* HTTP DELETE /asset
|
|
351
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
149
352
|
*/
|
|
150
|
-
|
|
353
|
+
delete(queryParams?: {
|
|
354
|
+
assetId?: string[];
|
|
355
|
+
}, options?: O): RestResponse<void>;
|
|
151
356
|
/**
|
|
152
|
-
* HTTP
|
|
153
|
-
* Java method: org.openremote.model.
|
|
357
|
+
* HTTP PUT /asset/attributes
|
|
358
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
154
359
|
*/
|
|
155
|
-
|
|
360
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
156
361
|
/**
|
|
157
|
-
* HTTP
|
|
158
|
-
* Java method: org.openremote.model.
|
|
362
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
363
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
159
364
|
*/
|
|
160
|
-
|
|
161
|
-
level?: Model.SyslogLevel;
|
|
162
|
-
per_page?: number;
|
|
163
|
-
page?: number;
|
|
164
|
-
from?: number;
|
|
165
|
-
to?: number;
|
|
166
|
-
category?: Model.SyslogCategory[];
|
|
167
|
-
subCategory?: string[];
|
|
168
|
-
}, options?: O): RestResponse<any>;
|
|
169
|
-
}
|
|
170
|
-
export declare class MapResourceClient<O> {
|
|
171
|
-
protected httpClient: HttpClient<O>;
|
|
172
|
-
constructor(httpClient: HttpClient<O>);
|
|
173
|
-
/**
|
|
174
|
-
* HTTP GET /map
|
|
175
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
176
|
-
*/
|
|
177
|
-
getSettings(options?: O): RestResponse<{
|
|
178
|
-
[id: string]: unknown;
|
|
179
|
-
}>;
|
|
180
|
-
/**
|
|
181
|
-
* HTTP PUT /map
|
|
182
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
183
|
-
*/
|
|
184
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
185
|
-
[id: string]: unknown;
|
|
186
|
-
}>;
|
|
187
|
-
/**
|
|
188
|
-
* HTTP DELETE /map/deleteMap
|
|
189
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
190
|
-
*/
|
|
191
|
-
deleteMap(options?: O): RestResponse<{
|
|
192
|
-
[id: string]: unknown;
|
|
193
|
-
}>;
|
|
194
|
-
/**
|
|
195
|
-
* HTTP GET /map/getCustomMapInfo
|
|
196
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
197
|
-
*/
|
|
198
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
199
|
-
[id: string]: unknown;
|
|
200
|
-
}>;
|
|
201
|
-
/**
|
|
202
|
-
* HTTP GET /map/js
|
|
203
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
204
|
-
*/
|
|
205
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
206
|
-
[id: string]: unknown;
|
|
207
|
-
}>;
|
|
365
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
208
366
|
/**
|
|
209
|
-
* HTTP
|
|
210
|
-
* Java method: org.openremote.model.
|
|
367
|
+
* HTTP DELETE /asset/parent
|
|
368
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
211
369
|
*/
|
|
212
|
-
|
|
370
|
+
updateNoneParent(queryParams?: {
|
|
371
|
+
assetIds?: string[];
|
|
372
|
+
}, options?: O): RestResponse<void>;
|
|
213
373
|
/**
|
|
214
|
-
* HTTP
|
|
215
|
-
* Java method: org.openremote.model.
|
|
374
|
+
* HTTP GET /asset/partial/{assetId}
|
|
375
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
216
376
|
*/
|
|
217
|
-
|
|
218
|
-
filename?: string;
|
|
219
|
-
}, options?: O): RestResponse<{
|
|
220
|
-
[id: string]: unknown;
|
|
221
|
-
}>;
|
|
222
|
-
}
|
|
223
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
224
|
-
protected httpClient: HttpClient<O>;
|
|
225
|
-
constructor(httpClient: HttpClient<O>);
|
|
377
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
226
378
|
/**
|
|
227
|
-
* HTTP POST /asset/
|
|
228
|
-
* Java method: org.openremote.model.
|
|
379
|
+
* HTTP POST /asset/query
|
|
380
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
229
381
|
*/
|
|
230
|
-
|
|
382
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
231
383
|
/**
|
|
232
|
-
* HTTP
|
|
233
|
-
* Java method: org.openremote.model.
|
|
384
|
+
* HTTP POST /asset/tree
|
|
385
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
234
386
|
*/
|
|
235
|
-
|
|
236
|
-
}
|
|
237
|
-
export declare class AgentResourceClient<O> {
|
|
238
|
-
protected httpClient: HttpClient<O>;
|
|
239
|
-
constructor(httpClient: HttpClient<O>);
|
|
387
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
240
388
|
/**
|
|
241
|
-
* HTTP GET /
|
|
242
|
-
* Java method: org.openremote.model.asset.
|
|
389
|
+
* HTTP GET /asset/user/current
|
|
390
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
243
391
|
*/
|
|
244
|
-
|
|
245
|
-
realm?: string;
|
|
246
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
392
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
247
393
|
/**
|
|
248
|
-
* HTTP POST /
|
|
249
|
-
* Java method: org.openremote.model.asset.
|
|
394
|
+
* HTTP POST /asset/user/link
|
|
395
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
250
396
|
*/
|
|
251
|
-
|
|
252
|
-
realm?: string;
|
|
253
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
397
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
254
398
|
/**
|
|
255
|
-
* HTTP GET /
|
|
256
|
-
* Java method: org.openremote.model.asset.
|
|
399
|
+
* HTTP GET /asset/user/link
|
|
400
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
257
401
|
*/
|
|
258
|
-
|
|
259
|
-
parentId?: string;
|
|
402
|
+
getUserAssetLinks(queryParams?: {
|
|
260
403
|
realm?: string;
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
protected httpClient: HttpClient<O>;
|
|
265
|
-
constructor(httpClient: HttpClient<O>);
|
|
404
|
+
userId?: string;
|
|
405
|
+
assetId?: string;
|
|
406
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
266
407
|
/**
|
|
267
|
-
* HTTP POST /
|
|
268
|
-
* Java method: org.openremote.model.
|
|
408
|
+
* HTTP POST /asset/user/link/delete
|
|
409
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
269
410
|
*/
|
|
270
|
-
|
|
271
|
-
assetIds?: string[];
|
|
272
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
411
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
273
412
|
/**
|
|
274
|
-
* HTTP
|
|
275
|
-
* Java method: org.openremote.model.
|
|
413
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
414
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
276
415
|
*/
|
|
277
|
-
|
|
278
|
-
realm?: string;
|
|
279
|
-
status?: Model.AlarmStatus;
|
|
280
|
-
assetId?: string;
|
|
281
|
-
assigneeId?: string;
|
|
282
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
416
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
283
417
|
/**
|
|
284
|
-
* HTTP DELETE /
|
|
285
|
-
* Java method: org.openremote.model.
|
|
418
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
419
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
286
420
|
*/
|
|
287
|
-
|
|
421
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
288
422
|
/**
|
|
289
|
-
* HTTP
|
|
290
|
-
* Java method: org.openremote.model.
|
|
423
|
+
* HTTP GET /asset/{assetId}
|
|
424
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
291
425
|
*/
|
|
292
|
-
|
|
426
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
293
427
|
/**
|
|
294
|
-
* HTTP
|
|
295
|
-
* Java method: org.openremote.model.
|
|
428
|
+
* HTTP PUT /asset/{assetId}
|
|
429
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
296
430
|
*/
|
|
297
|
-
|
|
431
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
298
432
|
/**
|
|
299
|
-
* HTTP
|
|
300
|
-
* Java method: org.openremote.model.
|
|
433
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
434
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
301
435
|
*/
|
|
302
|
-
|
|
436
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
303
437
|
/**
|
|
304
|
-
* HTTP PUT /
|
|
305
|
-
* Java method: org.openremote.model.
|
|
438
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
439
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
306
440
|
*/
|
|
307
|
-
|
|
441
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
308
442
|
/**
|
|
309
|
-
* HTTP
|
|
310
|
-
* Java method: org.openremote.model.
|
|
443
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
444
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
311
445
|
*/
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
}, options?: O): RestResponse<
|
|
446
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
447
|
+
assetIds?: string[];
|
|
448
|
+
}, options?: O): RestResponse<void>;
|
|
315
449
|
}
|
|
316
450
|
export declare class AssetModelResourceClient<O> {
|
|
317
451
|
protected httpClient: HttpClient<O>;
|
|
@@ -366,230 +500,72 @@ export declare class AssetModelResourceClient<O> {
|
|
|
366
500
|
[index: string]: Model.ValueDescriptor;
|
|
367
501
|
}>;
|
|
368
502
|
}
|
|
369
|
-
export declare class
|
|
503
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
370
504
|
protected httpClient: HttpClient<O>;
|
|
371
505
|
constructor(httpClient: HttpClient<O>);
|
|
372
506
|
/**
|
|
373
|
-
* HTTP
|
|
374
|
-
* Java method: org.openremote.model.datapoint.
|
|
375
|
-
*/
|
|
376
|
-
getDatapointExport(queryParams?: {
|
|
377
|
-
attributeRefs?: string;
|
|
378
|
-
fromTimestamp?: number;
|
|
379
|
-
toTimestamp?: number;
|
|
380
|
-
}, options?: O): RestResponse<any>;
|
|
381
|
-
/**
|
|
382
|
-
* HTTP GET /asset/datapoint/periods
|
|
383
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
507
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
508
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
384
509
|
*/
|
|
385
|
-
|
|
386
|
-
assetId?: string;
|
|
387
|
-
attributeName?: string;
|
|
388
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
510
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
389
511
|
/**
|
|
390
|
-
* HTTP
|
|
391
|
-
* Java method: org.openremote.model.datapoint.
|
|
512
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
513
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
392
514
|
*/
|
|
393
|
-
|
|
515
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
394
516
|
}
|
|
395
|
-
export declare class
|
|
517
|
+
export declare class AlarmResourceClient<O> {
|
|
396
518
|
protected httpClient: HttpClient<O>;
|
|
397
519
|
constructor(httpClient: HttpClient<O>);
|
|
398
520
|
/**
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
521
|
+
* HTTP POST /alarm
|
|
522
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
402
523
|
*/
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
}, options?: O): RestResponse<Model.
|
|
524
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
525
|
+
assetIds?: string[];
|
|
526
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
406
527
|
/**
|
|
407
|
-
*
|
|
408
|
-
*
|
|
409
|
-
* Response code 409 - ExternalService instance already registered
|
|
410
|
-
* HTTP POST /service
|
|
411
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
528
|
+
* HTTP GET /alarm
|
|
529
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
412
530
|
*/
|
|
413
|
-
|
|
531
|
+
getAlarms(queryParams?: {
|
|
532
|
+
realm?: string;
|
|
533
|
+
status?: Model.AlarmStatus;
|
|
534
|
+
assetId?: string;
|
|
535
|
+
assigneeId?: string;
|
|
536
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
414
537
|
/**
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
538
|
+
* HTTP DELETE /alarm
|
|
539
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
418
540
|
*/
|
|
419
|
-
|
|
541
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
420
542
|
/**
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
* Response code 409 - ExternalService instance already registered
|
|
424
|
-
* HTTP POST /service/global
|
|
425
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
543
|
+
* HTTP PUT /alarm/assets
|
|
544
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
426
545
|
*/
|
|
427
|
-
|
|
546
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
428
547
|
/**
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
432
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
548
|
+
* HTTP GET /alarm/{alarmId}
|
|
549
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
433
550
|
*/
|
|
434
|
-
|
|
551
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
435
552
|
/**
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
439
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
553
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
554
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
440
555
|
*/
|
|
441
|
-
|
|
442
|
-
/**
|
|
443
|
-
* Response code 204 - Heartbeat sent successfully
|
|
444
|
-
* Response code 404 - Service instance not found
|
|
445
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
446
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
447
|
-
*/
|
|
448
|
-
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
449
|
-
}
|
|
450
|
-
export declare class FlowResourceClient<O> {
|
|
451
|
-
protected httpClient: HttpClient<O>;
|
|
452
|
-
constructor(httpClient: HttpClient<O>);
|
|
453
|
-
/**
|
|
454
|
-
* HTTP GET /flow
|
|
455
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
456
|
-
*/
|
|
457
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
458
|
-
/**
|
|
459
|
-
* HTTP GET /flow/{name}
|
|
460
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
461
|
-
*/
|
|
462
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
463
|
-
/**
|
|
464
|
-
* HTTP GET /flow/{type}
|
|
465
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
466
|
-
*/
|
|
467
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
468
|
-
}
|
|
469
|
-
export declare class ConfigurationResourceClient<O> {
|
|
470
|
-
protected httpClient: HttpClient<O>;
|
|
471
|
-
constructor(httpClient: HttpClient<O>);
|
|
472
|
-
/**
|
|
473
|
-
* HTTP GET /configuration/manager
|
|
474
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
475
|
-
*/
|
|
476
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
477
|
-
/**
|
|
478
|
-
* HTTP PUT /configuration/manager
|
|
479
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
480
|
-
*/
|
|
481
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
482
|
-
/**
|
|
483
|
-
* HTTP POST /configuration/manager/file
|
|
484
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
485
|
-
*/
|
|
486
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
487
|
-
path?: string;
|
|
488
|
-
}, options?: O): RestResponse<string>;
|
|
489
|
-
/**
|
|
490
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
491
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
492
|
-
*/
|
|
493
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
494
|
-
}
|
|
495
|
-
export declare class RealmResourceClient<O> {
|
|
496
|
-
protected httpClient: HttpClient<O>;
|
|
497
|
-
constructor(httpClient: HttpClient<O>);
|
|
498
|
-
/**
|
|
499
|
-
* HTTP POST /realm
|
|
500
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
501
|
-
*/
|
|
502
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
503
|
-
/**
|
|
504
|
-
* HTTP GET /realm
|
|
505
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
506
|
-
*/
|
|
507
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
508
|
-
/**
|
|
509
|
-
* HTTP GET /realm/accessible
|
|
510
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
511
|
-
*/
|
|
512
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
513
|
-
/**
|
|
514
|
-
* HTTP DELETE /realm/{name}
|
|
515
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
516
|
-
*/
|
|
517
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
518
|
-
/**
|
|
519
|
-
* HTTP GET /realm/{name}
|
|
520
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
521
|
-
*/
|
|
522
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
523
|
-
/**
|
|
524
|
-
* HTTP PUT /realm/{name}
|
|
525
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
526
|
-
*/
|
|
527
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
528
|
-
}
|
|
529
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
530
|
-
protected httpClient: HttpClient<O>;
|
|
531
|
-
constructor(httpClient: HttpClient<O>);
|
|
532
|
-
/**
|
|
533
|
-
* HTTP POST /gateway/tunnel
|
|
534
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
535
|
-
*/
|
|
536
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
537
|
-
/**
|
|
538
|
-
* HTTP DELETE /gateway/tunnel
|
|
539
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
540
|
-
*/
|
|
541
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
542
|
-
/**
|
|
543
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
544
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
545
|
-
*/
|
|
546
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
547
|
-
/**
|
|
548
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
549
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
550
|
-
*/
|
|
551
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
552
|
-
/**
|
|
553
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
554
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
555
|
-
*/
|
|
556
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
557
|
-
}
|
|
558
|
-
export declare class GatewayClientResourceClient<O> {
|
|
559
|
-
protected httpClient: HttpClient<O>;
|
|
560
|
-
constructor(httpClient: HttpClient<O>);
|
|
561
|
-
/**
|
|
562
|
-
* HTTP DELETE /gateway/connection
|
|
563
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
564
|
-
*/
|
|
565
|
-
deleteConnections(queryParams?: {
|
|
566
|
-
realm?: string[];
|
|
567
|
-
}, options?: O): RestResponse<void>;
|
|
568
|
-
/**
|
|
569
|
-
* HTTP GET /gateway/connection
|
|
570
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
571
|
-
*/
|
|
572
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
573
|
-
/**
|
|
574
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
575
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
576
|
-
*/
|
|
577
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
578
|
-
/**
|
|
579
|
-
* HTTP GET /gateway/connection/{realm}
|
|
580
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
581
|
-
*/
|
|
582
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
556
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
583
557
|
/**
|
|
584
|
-
* HTTP PUT /
|
|
585
|
-
* Java method: org.openremote.model.
|
|
558
|
+
* HTTP PUT /alarm/{alarmId}
|
|
559
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
586
560
|
*/
|
|
587
|
-
|
|
561
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
588
562
|
/**
|
|
589
|
-
* HTTP GET /
|
|
590
|
-
* Java method: org.openremote.model.
|
|
563
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
564
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
591
565
|
*/
|
|
592
|
-
|
|
566
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
567
|
+
realm?: string;
|
|
568
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
593
569
|
}
|
|
594
570
|
export declare class AppResourceClient<O> {
|
|
595
571
|
protected httpClient: HttpClient<O>;
|
|
@@ -610,63 +586,58 @@ export declare class AppResourceClient<O> {
|
|
|
610
586
|
*/
|
|
611
587
|
getAppInfos(options?: O): RestResponse<any>;
|
|
612
588
|
}
|
|
613
|
-
export declare class
|
|
589
|
+
export declare class MapResourceClient<O> {
|
|
614
590
|
protected httpClient: HttpClient<O>;
|
|
615
591
|
constructor(httpClient: HttpClient<O>);
|
|
616
592
|
/**
|
|
617
|
-
* HTTP
|
|
618
|
-
* Java method: org.openremote.model.
|
|
619
|
-
*/
|
|
620
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
621
|
-
/**
|
|
622
|
-
* HTTP PUT /dashboard
|
|
623
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
624
|
-
*/
|
|
625
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
626
|
-
/**
|
|
627
|
-
* HTTP GET /dashboard/all/{realm}
|
|
628
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
629
|
-
*/
|
|
630
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
631
|
-
/**
|
|
632
|
-
* HTTP POST /dashboard/query
|
|
633
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
593
|
+
* HTTP GET /map
|
|
594
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
634
595
|
*/
|
|
635
|
-
|
|
596
|
+
getSettings(options?: O): RestResponse<{
|
|
597
|
+
[id: string]: unknown;
|
|
598
|
+
}>;
|
|
636
599
|
/**
|
|
637
|
-
* HTTP
|
|
638
|
-
* Java method: org.openremote.model.
|
|
600
|
+
* HTTP PUT /map
|
|
601
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
639
602
|
*/
|
|
640
|
-
|
|
603
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
604
|
+
[id: string]: unknown;
|
|
605
|
+
}>;
|
|
641
606
|
/**
|
|
642
|
-
* HTTP
|
|
643
|
-
* Java method: org.openremote.model.
|
|
607
|
+
* HTTP DELETE /map/deleteMap
|
|
608
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
644
609
|
*/
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
protected httpClient: HttpClient<O>;
|
|
649
|
-
constructor(httpClient: HttpClient<O>);
|
|
610
|
+
deleteMap(options?: O): RestResponse<{
|
|
611
|
+
[id: string]: unknown;
|
|
612
|
+
}>;
|
|
650
613
|
/**
|
|
651
|
-
* HTTP
|
|
652
|
-
* Java method: org.openremote.model.
|
|
614
|
+
* HTTP GET /map/getCustomMapInfo
|
|
615
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
653
616
|
*/
|
|
654
|
-
|
|
617
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
618
|
+
[id: string]: unknown;
|
|
619
|
+
}>;
|
|
655
620
|
/**
|
|
656
|
-
* HTTP GET /
|
|
657
|
-
* Java method: org.openremote.model.
|
|
621
|
+
* HTTP GET /map/js
|
|
622
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
658
623
|
*/
|
|
659
|
-
|
|
624
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
625
|
+
[id: string]: unknown;
|
|
626
|
+
}>;
|
|
660
627
|
/**
|
|
661
|
-
* HTTP
|
|
662
|
-
* Java method: org.openremote.model.
|
|
628
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
629
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
663
630
|
*/
|
|
664
|
-
|
|
631
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
665
632
|
/**
|
|
666
|
-
* HTTP
|
|
667
|
-
* Java method: org.openremote.model.
|
|
633
|
+
* HTTP POST /map/upload
|
|
634
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
668
635
|
*/
|
|
669
|
-
|
|
636
|
+
uploadMap(queryParams?: {
|
|
637
|
+
filename?: string;
|
|
638
|
+
}, options?: O): RestResponse<{
|
|
639
|
+
[id: string]: unknown;
|
|
640
|
+
}>;
|
|
670
641
|
}
|
|
671
642
|
export declare class ConsoleResourceClient<O> {
|
|
672
643
|
protected httpClient: HttpClient<O>;
|
|
@@ -677,114 +648,31 @@ export declare class ConsoleResourceClient<O> {
|
|
|
677
648
|
*/
|
|
678
649
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
679
650
|
}
|
|
680
|
-
export declare class
|
|
651
|
+
export declare class AgentResourceClient<O> {
|
|
681
652
|
protected httpClient: HttpClient<O>;
|
|
682
653
|
constructor(httpClient: HttpClient<O>);
|
|
683
654
|
/**
|
|
684
|
-
* HTTP
|
|
685
|
-
* Java method: org.openremote.model.asset.
|
|
686
|
-
*/
|
|
687
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
688
|
-
/**
|
|
689
|
-
* HTTP DELETE /asset
|
|
690
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
691
|
-
*/
|
|
692
|
-
delete(queryParams?: {
|
|
693
|
-
assetId?: string[];
|
|
694
|
-
}, options?: O): RestResponse<void>;
|
|
695
|
-
/**
|
|
696
|
-
* HTTP PUT /asset/attributes
|
|
697
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
698
|
-
*/
|
|
699
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
700
|
-
/**
|
|
701
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
702
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
703
|
-
*/
|
|
704
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
705
|
-
/**
|
|
706
|
-
* HTTP DELETE /asset/parent
|
|
707
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
708
|
-
*/
|
|
709
|
-
updateNoneParent(queryParams?: {
|
|
710
|
-
assetIds?: string[];
|
|
711
|
-
}, options?: O): RestResponse<void>;
|
|
712
|
-
/**
|
|
713
|
-
* HTTP GET /asset/partial/{assetId}
|
|
714
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
715
|
-
*/
|
|
716
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
717
|
-
/**
|
|
718
|
-
* HTTP POST /asset/query
|
|
719
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
720
|
-
*/
|
|
721
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
722
|
-
/**
|
|
723
|
-
* HTTP POST /asset/tree
|
|
724
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
725
|
-
*/
|
|
726
|
-
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
727
|
-
/**
|
|
728
|
-
* HTTP GET /asset/user/current
|
|
729
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
730
|
-
*/
|
|
731
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
732
|
-
/**
|
|
733
|
-
* HTTP POST /asset/user/link
|
|
734
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
735
|
-
*/
|
|
736
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
737
|
-
/**
|
|
738
|
-
* HTTP GET /asset/user/link
|
|
739
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
655
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
656
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
740
657
|
*/
|
|
741
|
-
|
|
658
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
742
659
|
realm?: string;
|
|
743
|
-
|
|
744
|
-
assetId?: string;
|
|
745
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
746
|
-
/**
|
|
747
|
-
* HTTP POST /asset/user/link/delete
|
|
748
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
749
|
-
*/
|
|
750
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
751
|
-
/**
|
|
752
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
753
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
754
|
-
*/
|
|
755
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
756
|
-
/**
|
|
757
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
758
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
759
|
-
*/
|
|
760
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
761
|
-
/**
|
|
762
|
-
* HTTP GET /asset/{assetId}
|
|
763
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
764
|
-
*/
|
|
765
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
766
|
-
/**
|
|
767
|
-
* HTTP PUT /asset/{assetId}
|
|
768
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
769
|
-
*/
|
|
770
|
-
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
771
|
-
/**
|
|
772
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
773
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
774
|
-
*/
|
|
775
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
660
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
776
661
|
/**
|
|
777
|
-
* HTTP
|
|
778
|
-
* Java method: org.openremote.model.asset.
|
|
662
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
663
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
779
664
|
*/
|
|
780
|
-
|
|
665
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
666
|
+
realm?: string;
|
|
667
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
781
668
|
/**
|
|
782
|
-
* HTTP
|
|
783
|
-
* Java method: org.openremote.model.asset.
|
|
669
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
670
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
784
671
|
*/
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
672
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
673
|
+
parentId?: string;
|
|
674
|
+
realm?: string;
|
|
675
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
788
676
|
}
|
|
789
677
|
export declare class UserResourceClient<O> {
|
|
790
678
|
protected httpClient: HttpClient<O>;
|
|
@@ -850,167 +738,279 @@ export declare class UserResourceClient<O> {
|
|
|
850
738
|
*/
|
|
851
739
|
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
852
740
|
/**
|
|
853
|
-
* HTTP PUT /user/{realm}/roles
|
|
854
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
741
|
+
* HTTP PUT /user/{realm}/roles
|
|
742
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
743
|
+
*/
|
|
744
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
745
|
+
/**
|
|
746
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
747
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
748
|
+
*/
|
|
749
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
750
|
+
/**
|
|
751
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
752
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
753
|
+
*/
|
|
754
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
755
|
+
/**
|
|
756
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
757
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
758
|
+
*/
|
|
759
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
760
|
+
/**
|
|
761
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
762
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
763
|
+
*/
|
|
764
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
765
|
+
/**
|
|
766
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
767
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
768
|
+
*/
|
|
769
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
770
|
+
/**
|
|
771
|
+
* HTTP POST /user/{realm}/users
|
|
772
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
773
|
+
*/
|
|
774
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
775
|
+
/**
|
|
776
|
+
* HTTP PUT /user/{realm}/users
|
|
777
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
778
|
+
*/
|
|
779
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
780
|
+
/**
|
|
781
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
782
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
783
|
+
*/
|
|
784
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
785
|
+
/**
|
|
786
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
787
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
788
|
+
*/
|
|
789
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
790
|
+
/**
|
|
791
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
792
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
793
|
+
*/
|
|
794
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
795
|
+
/**
|
|
796
|
+
* HTTP GET /user/{realm}/{userId}
|
|
797
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
798
|
+
*/
|
|
799
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
800
|
+
}
|
|
801
|
+
export declare class StatusResourceClient<O> {
|
|
802
|
+
protected httpClient: HttpClient<O>;
|
|
803
|
+
constructor(httpClient: HttpClient<O>);
|
|
804
|
+
/**
|
|
805
|
+
* HTTP GET /health
|
|
806
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
807
|
+
*/
|
|
808
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
809
|
+
[index: string]: any;
|
|
810
|
+
}>;
|
|
811
|
+
/**
|
|
812
|
+
* HTTP GET /info
|
|
813
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
814
|
+
*/
|
|
815
|
+
getInfo(options?: O): RestResponse<{
|
|
816
|
+
[index: string]: any;
|
|
817
|
+
}>;
|
|
818
|
+
}
|
|
819
|
+
export declare class RealmResourceClient<O> {
|
|
820
|
+
protected httpClient: HttpClient<O>;
|
|
821
|
+
constructor(httpClient: HttpClient<O>);
|
|
822
|
+
/**
|
|
823
|
+
* HTTP POST /realm
|
|
824
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
825
|
+
*/
|
|
826
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
827
|
+
/**
|
|
828
|
+
* HTTP GET /realm
|
|
829
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
830
|
+
*/
|
|
831
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
832
|
+
/**
|
|
833
|
+
* HTTP GET /realm/accessible
|
|
834
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
835
|
+
*/
|
|
836
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
837
|
+
/**
|
|
838
|
+
* HTTP DELETE /realm/{name}
|
|
839
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
840
|
+
*/
|
|
841
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
842
|
+
/**
|
|
843
|
+
* HTTP GET /realm/{name}
|
|
844
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
845
|
+
*/
|
|
846
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
847
|
+
/**
|
|
848
|
+
* HTTP PUT /realm/{name}
|
|
849
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
850
|
+
*/
|
|
851
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
852
|
+
}
|
|
853
|
+
export declare class FlowResourceClient<O> {
|
|
854
|
+
protected httpClient: HttpClient<O>;
|
|
855
|
+
constructor(httpClient: HttpClient<O>);
|
|
856
|
+
/**
|
|
857
|
+
* HTTP GET /flow
|
|
858
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
855
859
|
*/
|
|
856
|
-
|
|
860
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
857
861
|
/**
|
|
858
|
-
* HTTP GET /
|
|
859
|
-
* Java method: org.openremote.model.
|
|
862
|
+
* HTTP GET /flow/{name}
|
|
863
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
860
864
|
*/
|
|
861
|
-
|
|
865
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
862
866
|
/**
|
|
863
|
-
* HTTP
|
|
864
|
-
* Java method: org.openremote.model.
|
|
867
|
+
* HTTP GET /flow/{type}
|
|
868
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
865
869
|
*/
|
|
866
|
-
|
|
870
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
871
|
+
}
|
|
872
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
873
|
+
protected httpClient: HttpClient<O>;
|
|
874
|
+
constructor(httpClient: HttpClient<O>);
|
|
867
875
|
/**
|
|
868
|
-
* HTTP
|
|
869
|
-
* Java method: org.openremote.model.
|
|
876
|
+
* HTTP POST /gateway/tunnel
|
|
877
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
870
878
|
*/
|
|
871
|
-
|
|
879
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
872
880
|
/**
|
|
873
|
-
* HTTP
|
|
874
|
-
* Java method: org.openremote.model.
|
|
881
|
+
* HTTP DELETE /gateway/tunnel
|
|
882
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
875
883
|
*/
|
|
876
|
-
|
|
884
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
877
885
|
/**
|
|
878
|
-
* HTTP GET /
|
|
879
|
-
* Java method: org.openremote.model.
|
|
886
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
887
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
880
888
|
*/
|
|
881
|
-
|
|
889
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
882
890
|
/**
|
|
883
|
-
* HTTP
|
|
884
|
-
* Java method: org.openremote.model.
|
|
891
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
892
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
885
893
|
*/
|
|
886
|
-
|
|
894
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
887
895
|
/**
|
|
888
|
-
* HTTP
|
|
889
|
-
* Java method: org.openremote.model.
|
|
896
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
897
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
890
898
|
*/
|
|
891
|
-
|
|
899
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
900
|
+
}
|
|
901
|
+
export declare class SyslogResourceClient<O> {
|
|
902
|
+
protected httpClient: HttpClient<O>;
|
|
903
|
+
constructor(httpClient: HttpClient<O>);
|
|
892
904
|
/**
|
|
893
|
-
* HTTP
|
|
894
|
-
* Java method: org.openremote.model.
|
|
905
|
+
* HTTP GET /syslog/config
|
|
906
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
895
907
|
*/
|
|
896
|
-
|
|
908
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
897
909
|
/**
|
|
898
|
-
* HTTP
|
|
899
|
-
* Java method: org.openremote.model.
|
|
910
|
+
* HTTP PUT /syslog/config
|
|
911
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
900
912
|
*/
|
|
901
|
-
|
|
913
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
902
914
|
/**
|
|
903
|
-
* HTTP
|
|
904
|
-
* Java method: org.openremote.model.
|
|
915
|
+
* HTTP DELETE /syslog/event
|
|
916
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
905
917
|
*/
|
|
906
|
-
|
|
918
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
907
919
|
/**
|
|
908
|
-
* HTTP GET /
|
|
909
|
-
* Java method: org.openremote.model.
|
|
920
|
+
* HTTP GET /syslog/event
|
|
921
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
910
922
|
*/
|
|
911
|
-
|
|
923
|
+
getEvents(queryParams?: {
|
|
924
|
+
level?: Model.SyslogLevel;
|
|
925
|
+
per_page?: number;
|
|
926
|
+
page?: number;
|
|
927
|
+
from?: number;
|
|
928
|
+
to?: number;
|
|
929
|
+
category?: Model.SyslogCategory[];
|
|
930
|
+
subCategory?: string[];
|
|
931
|
+
}, options?: O): RestResponse<any>;
|
|
912
932
|
}
|
|
913
|
-
export declare class
|
|
933
|
+
export declare class DashboardResourceClient<O> {
|
|
914
934
|
protected httpClient: HttpClient<O>;
|
|
915
935
|
constructor(httpClient: HttpClient<O>);
|
|
916
936
|
/**
|
|
917
|
-
* HTTP
|
|
918
|
-
* Java method: org.openremote.model.
|
|
937
|
+
* HTTP POST /dashboard
|
|
938
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
919
939
|
*/
|
|
920
|
-
|
|
921
|
-
id?: number;
|
|
922
|
-
type?: string;
|
|
923
|
-
from?: number;
|
|
924
|
-
to?: number;
|
|
925
|
-
realmId?: string;
|
|
926
|
-
userId?: string;
|
|
927
|
-
assetId?: string;
|
|
928
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
940
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
929
941
|
/**
|
|
930
|
-
* HTTP
|
|
931
|
-
* Java method: org.openremote.model.
|
|
942
|
+
* HTTP PUT /dashboard
|
|
943
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
932
944
|
*/
|
|
933
|
-
|
|
934
|
-
id?: number;
|
|
935
|
-
type?: string;
|
|
936
|
-
from?: number;
|
|
937
|
-
to?: number;
|
|
938
|
-
realmId?: string;
|
|
939
|
-
userId?: string;
|
|
940
|
-
assetId?: string;
|
|
941
|
-
}, options?: O): RestResponse<void>;
|
|
945
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
942
946
|
/**
|
|
943
|
-
* HTTP
|
|
944
|
-
* Java method: org.openremote.model.
|
|
947
|
+
* HTTP GET /dashboard/all/{realm}
|
|
948
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
945
949
|
*/
|
|
946
|
-
|
|
950
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
947
951
|
/**
|
|
948
|
-
* HTTP
|
|
949
|
-
* Java method: org.openremote.model.
|
|
952
|
+
* HTTP POST /dashboard/query
|
|
953
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
950
954
|
*/
|
|
951
|
-
|
|
955
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
952
956
|
/**
|
|
953
|
-
* HTTP
|
|
954
|
-
* Java method: org.openremote.model.
|
|
957
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
958
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
955
959
|
*/
|
|
956
|
-
|
|
957
|
-
targetId?: string;
|
|
958
|
-
}, options?: O): RestResponse<void>;
|
|
960
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
959
961
|
/**
|
|
960
|
-
* HTTP
|
|
961
|
-
* Java method: org.openremote.model.
|
|
962
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
963
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
962
964
|
*/
|
|
963
|
-
|
|
964
|
-
targetId?: string;
|
|
965
|
-
}, options?: O): RestResponse<void>;
|
|
965
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
-
protected
|
|
969
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
970
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
971
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
972
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
973
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
974
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
970
975
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
971
|
-
protected
|
|
972
|
-
protected
|
|
976
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
977
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
973
978
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
974
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
975
979
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
976
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
977
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
978
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
979
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
980
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
981
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
982
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
983
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
984
980
|
protected _appResource: AxiosAppResourceClient;
|
|
985
|
-
protected
|
|
986
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
981
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
987
982
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
988
|
-
protected
|
|
983
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
989
984
|
protected _userResource: AxiosUserResourceClient;
|
|
990
|
-
protected
|
|
985
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
986
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
987
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
988
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
989
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
990
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
get
|
|
992
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
993
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
994
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
995
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
996
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
997
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
993
998
|
get RulesResource(): AxiosRulesResourceClient;
|
|
994
|
-
get
|
|
995
|
-
get
|
|
999
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1000
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
996
1001
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
997
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
998
1002
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
999
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1000
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1001
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1002
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1003
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1004
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1005
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1006
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1007
1003
|
get AppResource(): AxiosAppResourceClient;
|
|
1008
|
-
get
|
|
1009
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1004
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1010
1005
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1011
|
-
get
|
|
1006
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1012
1007
|
get UserResource(): AxiosUserResourceClient;
|
|
1013
|
-
get
|
|
1008
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1009
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1010
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1011
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1012
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1013
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1018,69 +1018,69 @@ declare module "axios" {
|
|
|
1018
1018
|
data: R;
|
|
1019
1019
|
}
|
|
1020
1020
|
}
|
|
1021
|
-
export declare class
|
|
1021
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
|
-
export declare class
|
|
1027
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
|
-
export declare class
|
|
1030
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1033
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1035
|
}
|
|
1036
|
-
export declare class
|
|
1036
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1038
|
}
|
|
1039
|
-
export declare class
|
|
1039
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1041
|
}
|
|
1042
|
-
export declare class
|
|
1042
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1044
|
}
|
|
1045
|
-
export declare class
|
|
1045
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1047
|
}
|
|
1048
|
-
export declare class
|
|
1048
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1050
|
}
|
|
1051
|
-
export declare class
|
|
1051
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1053
|
}
|
|
1054
|
-
export declare class
|
|
1054
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1056
|
}
|
|
1057
|
-
export declare class
|
|
1057
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1059
|
}
|
|
1060
|
-
export declare class
|
|
1060
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1062
|
}
|
|
1063
|
-
export declare class
|
|
1063
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1065
|
}
|
|
1066
|
-
export declare class
|
|
1066
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1068
|
}
|
|
1069
|
-
export declare class
|
|
1069
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1071
|
}
|
|
1072
|
-
export declare class
|
|
1072
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1074
|
}
|
|
1075
|
-
export declare class
|
|
1075
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1077
|
}
|
|
1078
|
-
export declare class
|
|
1078
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1080
|
}
|
|
1081
|
-
export declare class
|
|
1081
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1083
|
}
|
|
1084
|
-
export declare class
|
|
1084
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|