@openremote/rest 1.9.0-snapshot.20250922144133 → 1.9.0-snapshot.20250924083446
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 +464 -464
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,6 +9,191 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class ConsoleResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP POST /console/register
|
|
17
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
18
|
+
*/
|
|
19
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
20
|
+
}
|
|
21
|
+
export declare class AssetResourceClient<O> {
|
|
22
|
+
protected httpClient: HttpClient<O>;
|
|
23
|
+
constructor(httpClient: HttpClient<O>);
|
|
24
|
+
/**
|
|
25
|
+
* HTTP POST /asset
|
|
26
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
27
|
+
*/
|
|
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?: {
|
|
51
|
+
assetIds?: string[];
|
|
52
|
+
}, options?: O): RestResponse<void>;
|
|
53
|
+
/**
|
|
54
|
+
* HTTP GET /asset/partial/{assetId}
|
|
55
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
56
|
+
*/
|
|
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?: {
|
|
78
|
+
realm?: string;
|
|
79
|
+
userId?: string;
|
|
80
|
+
assetId?: string;
|
|
81
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
82
|
+
/**
|
|
83
|
+
* HTTP POST /asset/user/link/delete
|
|
84
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
85
|
+
*/
|
|
86
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
87
|
+
/**
|
|
88
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
89
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
90
|
+
*/
|
|
91
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
92
|
+
/**
|
|
93
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
94
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
95
|
+
*/
|
|
96
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
97
|
+
/**
|
|
98
|
+
* HTTP GET /asset/{assetId}
|
|
99
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
100
|
+
*/
|
|
101
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
102
|
+
/**
|
|
103
|
+
* HTTP PUT /asset/{assetId}
|
|
104
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
105
|
+
*/
|
|
106
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
107
|
+
/**
|
|
108
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
109
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
110
|
+
*/
|
|
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>;
|
|
124
|
+
}
|
|
125
|
+
export declare class StatusResourceClient<O> {
|
|
126
|
+
protected httpClient: HttpClient<O>;
|
|
127
|
+
constructor(httpClient: HttpClient<O>);
|
|
128
|
+
/**
|
|
129
|
+
* HTTP GET /health
|
|
130
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
131
|
+
*/
|
|
132
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
133
|
+
[index: string]: any;
|
|
134
|
+
}>;
|
|
135
|
+
/**
|
|
136
|
+
* HTTP GET /info
|
|
137
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
138
|
+
*/
|
|
139
|
+
getInfo(options?: O): RestResponse<{
|
|
140
|
+
[index: string]: any;
|
|
141
|
+
}>;
|
|
142
|
+
}
|
|
143
|
+
export declare class NotificationResourceClient<O> {
|
|
144
|
+
protected httpClient: HttpClient<O>;
|
|
145
|
+
constructor(httpClient: HttpClient<O>);
|
|
146
|
+
/**
|
|
147
|
+
* HTTP GET /notification
|
|
148
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
149
|
+
*/
|
|
150
|
+
getNotifications(queryParams?: {
|
|
151
|
+
id?: number;
|
|
152
|
+
type?: string;
|
|
153
|
+
from?: number;
|
|
154
|
+
to?: number;
|
|
155
|
+
realmId?: string;
|
|
156
|
+
userId?: string;
|
|
157
|
+
assetId?: string;
|
|
158
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
159
|
+
/**
|
|
160
|
+
* HTTP DELETE /notification
|
|
161
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
162
|
+
*/
|
|
163
|
+
removeNotifications(queryParams?: {
|
|
164
|
+
id?: number;
|
|
165
|
+
type?: string;
|
|
166
|
+
from?: number;
|
|
167
|
+
to?: number;
|
|
168
|
+
realmId?: string;
|
|
169
|
+
userId?: string;
|
|
170
|
+
assetId?: string;
|
|
171
|
+
}, options?: O): RestResponse<void>;
|
|
172
|
+
/**
|
|
173
|
+
* HTTP POST /notification/alert
|
|
174
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
175
|
+
*/
|
|
176
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
177
|
+
/**
|
|
178
|
+
* HTTP DELETE /notification/{notificationId}
|
|
179
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
180
|
+
*/
|
|
181
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
182
|
+
/**
|
|
183
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
184
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
185
|
+
*/
|
|
186
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
187
|
+
targetId?: string;
|
|
188
|
+
}, options?: O): RestResponse<void>;
|
|
189
|
+
/**
|
|
190
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
191
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
192
|
+
*/
|
|
193
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
194
|
+
targetId?: string;
|
|
195
|
+
}, options?: O): RestResponse<void>;
|
|
196
|
+
}
|
|
12
197
|
export declare class SyslogResourceClient<O> {
|
|
13
198
|
protected httpClient: HttpClient<O>;
|
|
14
199
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -41,86 +226,105 @@ export declare class SyslogResourceClient<O> {
|
|
|
41
226
|
subCategory?: string[];
|
|
42
227
|
}, options?: O): RestResponse<any>;
|
|
43
228
|
}
|
|
44
|
-
export declare class
|
|
229
|
+
export declare class AgentResourceClient<O> {
|
|
45
230
|
protected httpClient: HttpClient<O>;
|
|
46
231
|
constructor(httpClient: HttpClient<O>);
|
|
47
232
|
/**
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
233
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
234
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
51
235
|
*/
|
|
52
|
-
|
|
236
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
53
237
|
realm?: string;
|
|
54
|
-
}, options?: O): RestResponse<Model.
|
|
238
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
55
239
|
/**
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* Response code 409 - ExternalService instance already registered
|
|
59
|
-
* HTTP POST /service
|
|
60
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
240
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
241
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
61
242
|
*/
|
|
62
|
-
|
|
243
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
244
|
+
realm?: string;
|
|
245
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
63
246
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
247
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
248
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
67
249
|
*/
|
|
68
|
-
|
|
250
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
251
|
+
parentId?: string;
|
|
252
|
+
realm?: string;
|
|
253
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
254
|
+
}
|
|
255
|
+
export declare class AssetModelResourceClient<O> {
|
|
256
|
+
protected httpClient: HttpClient<O>;
|
|
257
|
+
constructor(httpClient: HttpClient<O>);
|
|
69
258
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
* Response code 409 - ExternalService instance already registered
|
|
73
|
-
* HTTP POST /service/global
|
|
74
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
259
|
+
* HTTP GET /model/assetDescriptors
|
|
260
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
75
261
|
*/
|
|
76
|
-
|
|
262
|
+
getAssetDescriptors(queryParams?: {
|
|
263
|
+
parentId?: string;
|
|
264
|
+
parentType?: string;
|
|
265
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
77
266
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
81
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
267
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
268
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
82
269
|
*/
|
|
83
|
-
|
|
270
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
271
|
+
parentId?: string;
|
|
272
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
84
273
|
/**
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
88
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
274
|
+
* HTTP GET /model/assetInfos
|
|
275
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
89
276
|
*/
|
|
90
|
-
|
|
277
|
+
getAssetInfos(queryParams?: {
|
|
278
|
+
parentId?: string;
|
|
279
|
+
parentType?: string;
|
|
280
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
91
281
|
/**
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
95
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
282
|
+
* HTTP GET /model/metaItemDescriptors
|
|
283
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
96
284
|
*/
|
|
97
|
-
|
|
285
|
+
getMetaItemDescriptors(queryParams?: {
|
|
286
|
+
parentId?: string;
|
|
287
|
+
}, options?: O): RestResponse<{
|
|
288
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
289
|
+
}>;
|
|
290
|
+
/**
|
|
291
|
+
* HTTP GET /model/valueDescriptors
|
|
292
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
293
|
+
*/
|
|
294
|
+
getValueDescriptors(queryParams?: {
|
|
295
|
+
parentId?: string;
|
|
296
|
+
}, options?: O): RestResponse<{
|
|
297
|
+
[index: string]: Model.ValueDescriptor;
|
|
298
|
+
}>;
|
|
98
299
|
}
|
|
99
|
-
export declare class
|
|
300
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
100
301
|
protected httpClient: HttpClient<O>;
|
|
101
302
|
constructor(httpClient: HttpClient<O>);
|
|
102
303
|
/**
|
|
103
|
-
* HTTP
|
|
104
|
-
* Java method: org.openremote.model.
|
|
304
|
+
* HTTP POST /gateway/tunnel
|
|
305
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
105
306
|
*/
|
|
106
|
-
|
|
307
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
107
308
|
/**
|
|
108
|
-
* HTTP
|
|
109
|
-
* Java method: org.openremote.model.
|
|
309
|
+
* HTTP DELETE /gateway/tunnel
|
|
310
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
110
311
|
*/
|
|
111
|
-
|
|
312
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
112
313
|
/**
|
|
113
|
-
* HTTP
|
|
114
|
-
* Java method: org.openremote.model.
|
|
314
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
315
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
115
316
|
*/
|
|
116
|
-
|
|
117
|
-
path?: string;
|
|
118
|
-
}, options?: O): RestResponse<string>;
|
|
317
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
119
318
|
/**
|
|
120
|
-
* HTTP GET /
|
|
121
|
-
* Java method: org.openremote.model.
|
|
319
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
320
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
122
321
|
*/
|
|
123
|
-
|
|
322
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
323
|
+
/**
|
|
324
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
325
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
326
|
+
*/
|
|
327
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
124
328
|
}
|
|
125
329
|
export declare class AssetDatapointResourceClient<O> {
|
|
126
330
|
protected httpClient: HttpClient<O>;
|
|
@@ -148,14 +352,39 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
148
352
|
*/
|
|
149
353
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
150
354
|
}
|
|
151
|
-
export declare class
|
|
355
|
+
export declare class RealmResourceClient<O> {
|
|
152
356
|
protected httpClient: HttpClient<O>;
|
|
153
357
|
constructor(httpClient: HttpClient<O>);
|
|
154
358
|
/**
|
|
155
|
-
* HTTP POST /
|
|
156
|
-
* Java method: org.openremote.model.
|
|
359
|
+
* HTTP POST /realm
|
|
360
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
157
361
|
*/
|
|
158
|
-
|
|
362
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
363
|
+
/**
|
|
364
|
+
* HTTP GET /realm
|
|
365
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
366
|
+
*/
|
|
367
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
368
|
+
/**
|
|
369
|
+
* HTTP GET /realm/accessible
|
|
370
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
371
|
+
*/
|
|
372
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
373
|
+
/**
|
|
374
|
+
* HTTP DELETE /realm/{name}
|
|
375
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
376
|
+
*/
|
|
377
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
378
|
+
/**
|
|
379
|
+
* HTTP GET /realm/{name}
|
|
380
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
381
|
+
*/
|
|
382
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
383
|
+
/**
|
|
384
|
+
* HTTP PUT /realm/{name}
|
|
385
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
386
|
+
*/
|
|
387
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
159
388
|
}
|
|
160
389
|
export declare class UserResourceClient<O> {
|
|
161
390
|
protected httpClient: HttpClient<O>;
|
|
@@ -270,120 +499,52 @@ export declare class UserResourceClient<O> {
|
|
|
270
499
|
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
271
500
|
*/
|
|
272
501
|
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
273
|
-
/**
|
|
274
|
-
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
275
|
-
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
276
|
-
*/
|
|
277
|
-
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
278
|
-
/**
|
|
279
|
-
* HTTP GET /user/{realm}/{userId}
|
|
280
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
281
|
-
*/
|
|
282
|
-
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
283
|
-
}
|
|
284
|
-
export declare class AssetResourceClient<O> {
|
|
285
|
-
protected httpClient: HttpClient<O>;
|
|
286
|
-
constructor(httpClient: HttpClient<O>);
|
|
287
|
-
/**
|
|
288
|
-
* HTTP POST /asset
|
|
289
|
-
* Java method: org.openremote.model.asset.AssetResource.create
|
|
290
|
-
*/
|
|
291
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP DELETE /asset
|
|
294
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
295
|
-
*/
|
|
296
|
-
delete(queryParams?: {
|
|
297
|
-
assetId?: string[];
|
|
298
|
-
}, options?: O): RestResponse<void>;
|
|
299
|
-
/**
|
|
300
|
-
* HTTP PUT /asset/attributes
|
|
301
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
302
|
-
*/
|
|
303
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
304
|
-
/**
|
|
305
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
306
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
307
|
-
*/
|
|
308
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
309
|
-
/**
|
|
310
|
-
* HTTP DELETE /asset/parent
|
|
311
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
312
|
-
*/
|
|
313
|
-
updateNoneParent(queryParams?: {
|
|
314
|
-
assetIds?: string[];
|
|
315
|
-
}, options?: O): RestResponse<void>;
|
|
316
|
-
/**
|
|
317
|
-
* HTTP GET /asset/partial/{assetId}
|
|
318
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
319
|
-
*/
|
|
320
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
321
|
-
/**
|
|
322
|
-
* HTTP POST /asset/query
|
|
323
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
324
|
-
*/
|
|
325
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
326
|
-
/**
|
|
327
|
-
* HTTP GET /asset/user/current
|
|
328
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
329
|
-
*/
|
|
330
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
331
|
-
/**
|
|
332
|
-
* HTTP POST /asset/user/link
|
|
333
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
334
|
-
*/
|
|
335
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP GET /asset/user/link
|
|
338
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
339
|
-
*/
|
|
340
|
-
getUserAssetLinks(queryParams?: {
|
|
341
|
-
realm?: string;
|
|
342
|
-
userId?: string;
|
|
343
|
-
assetId?: string;
|
|
344
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
345
|
-
/**
|
|
346
|
-
* HTTP POST /asset/user/link/delete
|
|
347
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
502
|
+
/**
|
|
503
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
504
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
348
505
|
*/
|
|
349
|
-
|
|
506
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
350
507
|
/**
|
|
351
|
-
* HTTP
|
|
352
|
-
* Java method: org.openremote.model.
|
|
508
|
+
* HTTP GET /user/{realm}/{userId}
|
|
509
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
353
510
|
*/
|
|
354
|
-
|
|
511
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
512
|
+
}
|
|
513
|
+
export declare class GatewayClientResourceClient<O> {
|
|
514
|
+
protected httpClient: HttpClient<O>;
|
|
515
|
+
constructor(httpClient: HttpClient<O>);
|
|
355
516
|
/**
|
|
356
|
-
* HTTP DELETE /
|
|
357
|
-
* Java method: org.openremote.model.
|
|
517
|
+
* HTTP DELETE /gateway/connection
|
|
518
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
358
519
|
*/
|
|
359
|
-
|
|
520
|
+
deleteConnections(queryParams?: {
|
|
521
|
+
realm?: string[];
|
|
522
|
+
}, options?: O): RestResponse<void>;
|
|
360
523
|
/**
|
|
361
|
-
* HTTP GET /
|
|
362
|
-
* Java method: org.openremote.model.
|
|
524
|
+
* HTTP GET /gateway/connection
|
|
525
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
363
526
|
*/
|
|
364
|
-
|
|
527
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
365
528
|
/**
|
|
366
|
-
* HTTP
|
|
367
|
-
* Java method: org.openremote.model.
|
|
529
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
530
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
368
531
|
*/
|
|
369
|
-
|
|
532
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
370
533
|
/**
|
|
371
|
-
* HTTP
|
|
372
|
-
* Java method: org.openremote.model.
|
|
534
|
+
* HTTP GET /gateway/connection/{realm}
|
|
535
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
373
536
|
*/
|
|
374
|
-
|
|
537
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
375
538
|
/**
|
|
376
|
-
* HTTP PUT /
|
|
377
|
-
* Java method: org.openremote.model.
|
|
539
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
540
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
378
541
|
*/
|
|
379
|
-
|
|
542
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
380
543
|
/**
|
|
381
|
-
* HTTP
|
|
382
|
-
* Java method: org.openremote.model.
|
|
544
|
+
* HTTP GET /gateway/status/{realm}
|
|
545
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
383
546
|
*/
|
|
384
|
-
|
|
385
|
-
assetIds?: string[];
|
|
386
|
-
}, options?: O): RestResponse<void>;
|
|
547
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
387
548
|
}
|
|
388
549
|
export declare class AlarmResourceClient<O> {
|
|
389
550
|
protected httpClient: HttpClient<O>;
|
|
@@ -438,157 +599,24 @@ export declare class AlarmResourceClient<O> {
|
|
|
438
599
|
realm?: string;
|
|
439
600
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
440
601
|
}
|
|
441
|
-
export declare class
|
|
442
|
-
protected httpClient: HttpClient<O>;
|
|
443
|
-
constructor(httpClient: HttpClient<O>);
|
|
444
|
-
/**
|
|
445
|
-
* HTTP POST /provisioning
|
|
446
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
447
|
-
*/
|
|
448
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
449
|
-
/**
|
|
450
|
-
* HTTP GET /provisioning
|
|
451
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
452
|
-
*/
|
|
453
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
454
|
-
/**
|
|
455
|
-
* HTTP DELETE /provisioning/{id}
|
|
456
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
457
|
-
*/
|
|
458
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
459
|
-
/**
|
|
460
|
-
* HTTP PUT /provisioning/{id}
|
|
461
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
462
|
-
*/
|
|
463
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
464
|
-
}
|
|
465
|
-
export declare class AppResourceClient<O> {
|
|
466
|
-
protected httpClient: HttpClient<O>;
|
|
467
|
-
constructor(httpClient: HttpClient<O>);
|
|
468
|
-
/**
|
|
469
|
-
* HTTP GET /apps
|
|
470
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
471
|
-
*/
|
|
472
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
473
|
-
/**
|
|
474
|
-
* HTTP GET /apps/consoleConfig
|
|
475
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
476
|
-
*/
|
|
477
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
478
|
-
/**
|
|
479
|
-
* HTTP GET /apps/info
|
|
480
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
481
|
-
*/
|
|
482
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
483
|
-
}
|
|
484
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
485
|
-
protected httpClient: HttpClient<O>;
|
|
486
|
-
constructor(httpClient: HttpClient<O>);
|
|
487
|
-
/**
|
|
488
|
-
* HTTP POST /gateway/tunnel
|
|
489
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
490
|
-
*/
|
|
491
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
492
|
-
/**
|
|
493
|
-
* HTTP DELETE /gateway/tunnel
|
|
494
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
495
|
-
*/
|
|
496
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
497
|
-
/**
|
|
498
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
499
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
500
|
-
*/
|
|
501
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
502
|
-
/**
|
|
503
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
504
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
505
|
-
*/
|
|
506
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
507
|
-
/**
|
|
508
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
509
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
510
|
-
*/
|
|
511
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
512
|
-
}
|
|
513
|
-
export declare class StatusResourceClient<O> {
|
|
514
|
-
protected httpClient: HttpClient<O>;
|
|
515
|
-
constructor(httpClient: HttpClient<O>);
|
|
516
|
-
/**
|
|
517
|
-
* HTTP GET /health
|
|
518
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
519
|
-
*/
|
|
520
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
521
|
-
[index: string]: any;
|
|
522
|
-
}>;
|
|
523
|
-
/**
|
|
524
|
-
* HTTP GET /info
|
|
525
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
526
|
-
*/
|
|
527
|
-
getInfo(options?: O): RestResponse<{
|
|
528
|
-
[index: string]: any;
|
|
529
|
-
}>;
|
|
530
|
-
}
|
|
531
|
-
export declare class AgentResourceClient<O> {
|
|
532
|
-
protected httpClient: HttpClient<O>;
|
|
533
|
-
constructor(httpClient: HttpClient<O>);
|
|
534
|
-
/**
|
|
535
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
536
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
537
|
-
*/
|
|
538
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
539
|
-
realm?: string;
|
|
540
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
541
|
-
/**
|
|
542
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
543
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
544
|
-
*/
|
|
545
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
546
|
-
realm?: string;
|
|
547
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
548
|
-
/**
|
|
549
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
550
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
551
|
-
*/
|
|
552
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
553
|
-
parentId?: string;
|
|
554
|
-
realm?: string;
|
|
555
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
556
|
-
}
|
|
557
|
-
export declare class GatewayClientResourceClient<O> {
|
|
602
|
+
export declare class FlowResourceClient<O> {
|
|
558
603
|
protected httpClient: HttpClient<O>;
|
|
559
604
|
constructor(httpClient: HttpClient<O>);
|
|
560
605
|
/**
|
|
561
|
-
* HTTP
|
|
562
|
-
* Java method: org.openremote.model.
|
|
563
|
-
*/
|
|
564
|
-
deleteConnections(queryParams?: {
|
|
565
|
-
realm?: string[];
|
|
566
|
-
}, options?: O): RestResponse<void>;
|
|
567
|
-
/**
|
|
568
|
-
* HTTP GET /gateway/connection
|
|
569
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
570
|
-
*/
|
|
571
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
572
|
-
/**
|
|
573
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
574
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
575
|
-
*/
|
|
576
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
577
|
-
/**
|
|
578
|
-
* HTTP GET /gateway/connection/{realm}
|
|
579
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
606
|
+
* HTTP GET /flow
|
|
607
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
580
608
|
*/
|
|
581
|
-
|
|
609
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
582
610
|
/**
|
|
583
|
-
* HTTP
|
|
584
|
-
* Java method: org.openremote.model.
|
|
611
|
+
* HTTP GET /flow/{name}
|
|
612
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
585
613
|
*/
|
|
586
|
-
|
|
614
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
587
615
|
/**
|
|
588
|
-
* HTTP GET /
|
|
589
|
-
* Java method: org.openremote.model.
|
|
616
|
+
* HTTP GET /flow/{type}
|
|
617
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
590
618
|
*/
|
|
591
|
-
|
|
619
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
592
620
|
}
|
|
593
621
|
export declare class RulesResourceClient<O> {
|
|
594
622
|
protected httpClient: HttpClient<O>;
|
|
@@ -698,78 +726,50 @@ export declare class RulesResourceClient<O> {
|
|
|
698
726
|
*/
|
|
699
727
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
700
728
|
}
|
|
701
|
-
export declare class
|
|
729
|
+
export declare class ConfigurationResourceClient<O> {
|
|
702
730
|
protected httpClient: HttpClient<O>;
|
|
703
731
|
constructor(httpClient: HttpClient<O>);
|
|
704
732
|
/**
|
|
705
|
-
* HTTP GET /
|
|
706
|
-
* Java method: org.openremote.model.
|
|
707
|
-
*/
|
|
708
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
709
|
-
/**
|
|
710
|
-
* HTTP GET /flow/{name}
|
|
711
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
712
|
-
*/
|
|
713
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
714
|
-
/**
|
|
715
|
-
* HTTP GET /flow/{type}
|
|
716
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
733
|
+
* HTTP GET /configuration/manager
|
|
734
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
717
735
|
*/
|
|
718
|
-
|
|
719
|
-
}
|
|
720
|
-
export declare class NotificationResourceClient<O> {
|
|
721
|
-
protected httpClient: HttpClient<O>;
|
|
722
|
-
constructor(httpClient: HttpClient<O>);
|
|
736
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
723
737
|
/**
|
|
724
|
-
* HTTP
|
|
725
|
-
* Java method: org.openremote.model.
|
|
738
|
+
* HTTP PUT /configuration/manager
|
|
739
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
726
740
|
*/
|
|
727
|
-
|
|
728
|
-
id?: number;
|
|
729
|
-
type?: string;
|
|
730
|
-
from?: number;
|
|
731
|
-
to?: number;
|
|
732
|
-
realmId?: string;
|
|
733
|
-
userId?: string;
|
|
734
|
-
assetId?: string;
|
|
735
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
741
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
736
742
|
/**
|
|
737
|
-
* HTTP
|
|
738
|
-
* Java method: org.openremote.model.
|
|
739
|
-
*/
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
from?: number;
|
|
744
|
-
to?: number;
|
|
745
|
-
realmId?: string;
|
|
746
|
-
userId?: string;
|
|
747
|
-
assetId?: string;
|
|
748
|
-
}, options?: O): RestResponse<void>;
|
|
743
|
+
* HTTP POST /configuration/manager/file
|
|
744
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
745
|
+
*/
|
|
746
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
747
|
+
path?: string;
|
|
748
|
+
}, options?: O): RestResponse<string>;
|
|
749
749
|
/**
|
|
750
|
-
* HTTP
|
|
751
|
-
* Java method: org.openremote.model.
|
|
750
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
751
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
752
752
|
*/
|
|
753
|
-
|
|
753
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
754
|
+
}
|
|
755
|
+
export declare class AppResourceClient<O> {
|
|
756
|
+
protected httpClient: HttpClient<O>;
|
|
757
|
+
constructor(httpClient: HttpClient<O>);
|
|
754
758
|
/**
|
|
755
|
-
* HTTP
|
|
756
|
-
* Java method: org.openremote.model.
|
|
759
|
+
* HTTP GET /apps
|
|
760
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
757
761
|
*/
|
|
758
|
-
|
|
762
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
759
763
|
/**
|
|
760
|
-
* HTTP
|
|
761
|
-
* Java method: org.openremote.model.
|
|
764
|
+
* HTTP GET /apps/consoleConfig
|
|
765
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
762
766
|
*/
|
|
763
|
-
|
|
764
|
-
targetId?: string;
|
|
765
|
-
}, options?: O): RestResponse<void>;
|
|
767
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
766
768
|
/**
|
|
767
|
-
* HTTP
|
|
768
|
-
* Java method: org.openremote.model.
|
|
769
|
+
* HTTP GET /apps/info
|
|
770
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
769
771
|
*/
|
|
770
|
-
|
|
771
|
-
targetId?: string;
|
|
772
|
-
}, options?: O): RestResponse<void>;
|
|
772
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
773
773
|
}
|
|
774
774
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
775
775
|
protected httpClient: HttpClient<O>;
|
|
@@ -819,51 +819,6 @@ export declare class DashboardResourceClient<O> {
|
|
|
819
819
|
*/
|
|
820
820
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
821
821
|
}
|
|
822
|
-
export declare class AssetModelResourceClient<O> {
|
|
823
|
-
protected httpClient: HttpClient<O>;
|
|
824
|
-
constructor(httpClient: HttpClient<O>);
|
|
825
|
-
/**
|
|
826
|
-
* HTTP GET /model/assetDescriptors
|
|
827
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
828
|
-
*/
|
|
829
|
-
getAssetDescriptors(queryParams?: {
|
|
830
|
-
parentId?: string;
|
|
831
|
-
parentType?: string;
|
|
832
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
833
|
-
/**
|
|
834
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
835
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
836
|
-
*/
|
|
837
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
838
|
-
parentId?: string;
|
|
839
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
840
|
-
/**
|
|
841
|
-
* HTTP GET /model/assetInfos
|
|
842
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
843
|
-
*/
|
|
844
|
-
getAssetInfos(queryParams?: {
|
|
845
|
-
parentId?: string;
|
|
846
|
-
parentType?: string;
|
|
847
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
848
|
-
/**
|
|
849
|
-
* HTTP GET /model/metaItemDescriptors
|
|
850
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
851
|
-
*/
|
|
852
|
-
getMetaItemDescriptors(queryParams?: {
|
|
853
|
-
parentId?: string;
|
|
854
|
-
}, options?: O): RestResponse<{
|
|
855
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
856
|
-
}>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP GET /model/valueDescriptors
|
|
859
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
860
|
-
*/
|
|
861
|
-
getValueDescriptors(queryParams?: {
|
|
862
|
-
parentId?: string;
|
|
863
|
-
}, options?: O): RestResponse<{
|
|
864
|
-
[index: string]: Model.ValueDescriptor;
|
|
865
|
-
}>;
|
|
866
|
-
}
|
|
867
822
|
export declare class MapResourceClient<O> {
|
|
868
823
|
protected httpClient: HttpClient<O>;
|
|
869
824
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -917,87 +872,132 @@ export declare class MapResourceClient<O> {
|
|
|
917
872
|
[id: string]: unknown;
|
|
918
873
|
}>;
|
|
919
874
|
}
|
|
920
|
-
export declare class
|
|
875
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
921
876
|
protected httpClient: HttpClient<O>;
|
|
922
877
|
constructor(httpClient: HttpClient<O>);
|
|
923
878
|
/**
|
|
924
|
-
*
|
|
925
|
-
*
|
|
879
|
+
* Response code 200 - List of registered external services
|
|
880
|
+
* HTTP GET /service
|
|
881
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
926
882
|
*/
|
|
927
|
-
|
|
883
|
+
getServices(queryParams?: {
|
|
884
|
+
realm?: string;
|
|
885
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
928
886
|
/**
|
|
929
|
-
*
|
|
930
|
-
*
|
|
887
|
+
* Response code 200 - Service registered successfully
|
|
888
|
+
* Response code 400 - Invalid external service object
|
|
889
|
+
* Response code 409 - ExternalService instance already registered
|
|
890
|
+
* HTTP POST /service
|
|
891
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
931
892
|
*/
|
|
932
|
-
|
|
893
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
933
894
|
/**
|
|
934
|
-
*
|
|
935
|
-
*
|
|
895
|
+
* Response code 200 - List of registered external services
|
|
896
|
+
* HTTP GET /service/global
|
|
897
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
936
898
|
*/
|
|
937
|
-
|
|
899
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
938
900
|
/**
|
|
939
|
-
*
|
|
940
|
-
*
|
|
901
|
+
* Response code 200 - Service registered successfully
|
|
902
|
+
* Response code 400 - Invalid external service object
|
|
903
|
+
* Response code 409 - ExternalService instance already registered
|
|
904
|
+
* HTTP POST /service/global
|
|
905
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
941
906
|
*/
|
|
942
|
-
|
|
907
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
943
908
|
/**
|
|
944
|
-
*
|
|
945
|
-
*
|
|
909
|
+
* Response code 204 - Service deregistered successfully
|
|
910
|
+
* Response code 404 - Service instance not found
|
|
911
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
912
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
946
913
|
*/
|
|
947
|
-
|
|
914
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
948
915
|
/**
|
|
949
|
-
*
|
|
950
|
-
*
|
|
916
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
917
|
+
* Response code 404 - ExternalService not found
|
|
918
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
919
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
951
920
|
*/
|
|
952
|
-
|
|
921
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
922
|
+
/**
|
|
923
|
+
* Response code 204 - Heartbeat sent successfully
|
|
924
|
+
* Response code 404 - Service instance not found
|
|
925
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
926
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
927
|
+
*/
|
|
928
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
929
|
+
}
|
|
930
|
+
export declare class ProvisioningResourceClient<O> {
|
|
931
|
+
protected httpClient: HttpClient<O>;
|
|
932
|
+
constructor(httpClient: HttpClient<O>);
|
|
933
|
+
/**
|
|
934
|
+
* HTTP POST /provisioning
|
|
935
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
936
|
+
*/
|
|
937
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
938
|
+
/**
|
|
939
|
+
* HTTP GET /provisioning
|
|
940
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
941
|
+
*/
|
|
942
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
943
|
+
/**
|
|
944
|
+
* HTTP DELETE /provisioning/{id}
|
|
945
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
946
|
+
*/
|
|
947
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
948
|
+
/**
|
|
949
|
+
* HTTP PUT /provisioning/{id}
|
|
950
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
951
|
+
*/
|
|
952
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
953
953
|
}
|
|
954
954
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
955
955
|
export declare class ApiClient {
|
|
956
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
957
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
958
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
959
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
960
956
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
961
|
-
protected _userResource: AxiosUserResourceClient;
|
|
962
957
|
protected _assetResource: AxiosAssetResourceClient;
|
|
963
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
964
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
965
|
-
protected _appResource: AxiosAppResourceClient;
|
|
966
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
967
958
|
protected _statusResource: AxiosStatusResourceClient;
|
|
959
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
960
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
968
961
|
protected _agentResource: AxiosAgentResourceClient;
|
|
962
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
963
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
964
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
965
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
966
|
+
protected _userResource: AxiosUserResourceClient;
|
|
969
967
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
970
|
-
protected
|
|
968
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
971
969
|
protected _flowResource: AxiosFlowResourceClient;
|
|
972
|
-
protected
|
|
970
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
971
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
972
|
+
protected _appResource: AxiosAppResourceClient;
|
|
973
973
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
974
974
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
975
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
976
975
|
protected _mapResource: AxiosMapResourceClient;
|
|
977
|
-
protected
|
|
976
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
977
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
978
978
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
979
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
980
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
981
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
982
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
983
979
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
984
|
-
get UserResource(): AxiosUserResourceClient;
|
|
985
980
|
get AssetResource(): AxiosAssetResourceClient;
|
|
986
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
987
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
988
|
-
get AppResource(): AxiosAppResourceClient;
|
|
989
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
990
981
|
get StatusResource(): AxiosStatusResourceClient;
|
|
982
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
983
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
991
984
|
get AgentResource(): AxiosAgentResourceClient;
|
|
985
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
986
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
987
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
988
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
989
|
+
get UserResource(): AxiosUserResourceClient;
|
|
992
990
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
993
|
-
get
|
|
991
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
994
992
|
get FlowResource(): AxiosFlowResourceClient;
|
|
995
|
-
get
|
|
993
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
994
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
995
|
+
get AppResource(): AxiosAppResourceClient;
|
|
996
996
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
997
997
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
998
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
999
998
|
get MapResource(): AxiosMapResourceClient;
|
|
1000
|
-
get
|
|
999
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1000
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1001
1001
|
}
|
|
1002
1002
|
import * as Axios from "axios";
|
|
1003
1003
|
declare module "axios" {
|
|
@@ -1005,55 +1005,55 @@ declare module "axios" {
|
|
|
1005
1005
|
data: R;
|
|
1006
1006
|
}
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|
|
1014
|
-
export declare class
|
|
1014
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1015
1015
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1016
1016
|
}
|
|
1017
|
-
export declare class
|
|
1017
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1018
1018
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1019
1019
|
}
|
|
1020
|
-
export declare class
|
|
1020
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1021
1021
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1022
1022
|
}
|
|
1023
|
-
export declare class
|
|
1023
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1024
1024
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1025
1025
|
}
|
|
1026
|
-
export declare class
|
|
1026
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1027
1027
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1028
1028
|
}
|
|
1029
|
-
export declare class
|
|
1029
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1030
1030
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1031
1031
|
}
|
|
1032
|
-
export declare class
|
|
1032
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1033
1033
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1034
1034
|
}
|
|
1035
|
-
export declare class
|
|
1035
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1036
1036
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1037
1037
|
}
|
|
1038
|
-
export declare class
|
|
1038
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1039
1039
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1040
1040
|
}
|
|
1041
|
-
export declare class
|
|
1041
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1042
1042
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1043
1043
|
}
|
|
1044
|
-
export declare class
|
|
1044
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1045
1045
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1046
1046
|
}
|
|
1047
|
-
export declare class
|
|
1047
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1048
1048
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1049
1049
|
}
|
|
1050
1050
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1051
1051
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1052
1052
|
}
|
|
1053
|
-
export declare class
|
|
1053
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1054
1054
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1055
1055
|
}
|
|
1056
|
-
export declare class
|
|
1056
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1057
1057
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1058
1058
|
}
|
|
1059
1059
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1062,12 +1062,12 @@ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPre
|
|
|
1062
1062
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1063
1063
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1064
1064
|
}
|
|
1065
|
-
export declare class
|
|
1065
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1066
1066
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1067
1067
|
}
|
|
1068
|
-
export declare class
|
|
1068
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1069
1069
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1070
1070
|
}
|
|
1071
|
-
export declare class
|
|
1071
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1072
1072
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1073
1073
|
}
|