@openremote/rest 1.12.0-snapshot.20251209124232 → 1.12.0-snapshot.20251209132403
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 +454 -454
- 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,90 +9,132 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class StatusResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /health
|
|
17
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
19
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
20
|
+
[index: string]: any;
|
|
21
|
+
}>;
|
|
23
22
|
/**
|
|
24
|
-
* HTTP GET /
|
|
25
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /info
|
|
24
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
26
25
|
*/
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
}
|
|
26
|
+
getInfo(options?: O): RestResponse<{
|
|
27
|
+
[index: string]: any;
|
|
28
|
+
}>;
|
|
29
|
+
}
|
|
30
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
31
|
+
protected httpClient: HttpClient<O>;
|
|
32
|
+
constructor(httpClient: HttpClient<O>);
|
|
30
33
|
/**
|
|
31
|
-
*
|
|
32
|
-
*
|
|
34
|
+
* Response code 200 - List of registered external services
|
|
35
|
+
* HTTP GET /service
|
|
36
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
33
37
|
*/
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
38
|
+
getServices(queryParams?: {
|
|
39
|
+
realm?: string;
|
|
40
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
38
41
|
/**
|
|
39
|
-
*
|
|
40
|
-
*
|
|
42
|
+
* Response code 200 - Service registered successfully
|
|
43
|
+
* Response code 400 - Invalid external service object
|
|
44
|
+
* Response code 409 - ExternalService instance already registered
|
|
45
|
+
* HTTP POST /service
|
|
46
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
41
47
|
*/
|
|
42
|
-
|
|
43
|
-
name?: string;
|
|
44
|
-
hash?: string;
|
|
45
|
-
}, options?: O): RestResponse<any>;
|
|
48
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
46
49
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
50
|
+
* Response code 200 - List of registered external services
|
|
51
|
+
* HTTP GET /service/global
|
|
52
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
49
53
|
*/
|
|
50
|
-
|
|
51
|
-
parentId?: string;
|
|
52
|
-
}, options?: O): RestResponse<{
|
|
53
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
54
|
-
}>;
|
|
54
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
57
|
-
*
|
|
56
|
+
* Response code 200 - Service registered successfully
|
|
57
|
+
* Response code 400 - Invalid external service object
|
|
58
|
+
* Response code 409 - ExternalService instance already registered
|
|
59
|
+
* HTTP POST /service/global
|
|
60
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
58
61
|
*/
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
62
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
63
|
+
/**
|
|
64
|
+
* Response code 204 - Service deregistered successfully
|
|
65
|
+
* Response code 404 - Service instance not found
|
|
66
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
67
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
68
|
+
*/
|
|
69
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
70
|
+
/**
|
|
71
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
72
|
+
* Response code 404 - ExternalService not found
|
|
73
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
74
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
75
|
+
*/
|
|
76
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
77
|
+
/**
|
|
78
|
+
* Response code 204 - Heartbeat sent successfully
|
|
79
|
+
* Response code 404 - Service instance not found
|
|
80
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
81
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
82
|
+
*/
|
|
83
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
64
84
|
}
|
|
65
|
-
export declare class
|
|
85
|
+
export declare class NotificationResourceClient<O> {
|
|
66
86
|
protected httpClient: HttpClient<O>;
|
|
67
87
|
constructor(httpClient: HttpClient<O>);
|
|
68
88
|
/**
|
|
69
|
-
* HTTP GET /
|
|
70
|
-
* Java method: org.openremote.model.
|
|
89
|
+
* HTTP GET /notification
|
|
90
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
71
91
|
*/
|
|
72
|
-
|
|
92
|
+
getNotifications(queryParams?: {
|
|
93
|
+
id?: number;
|
|
94
|
+
type?: string;
|
|
95
|
+
from?: number;
|
|
96
|
+
to?: number;
|
|
97
|
+
realmId?: string;
|
|
98
|
+
userId?: string;
|
|
99
|
+
assetId?: string;
|
|
100
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
73
101
|
/**
|
|
74
|
-
* HTTP
|
|
75
|
-
* Java method: org.openremote.model.
|
|
102
|
+
* HTTP DELETE /notification
|
|
103
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
76
104
|
*/
|
|
77
|
-
|
|
105
|
+
removeNotifications(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<void>;
|
|
78
114
|
/**
|
|
79
|
-
* HTTP
|
|
80
|
-
* Java method: org.openremote.model.
|
|
115
|
+
* HTTP POST /notification/alert
|
|
116
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
81
117
|
*/
|
|
82
|
-
|
|
118
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
83
119
|
/**
|
|
84
|
-
* HTTP
|
|
85
|
-
* Java method: org.openremote.model.
|
|
120
|
+
* HTTP DELETE /notification/{notificationId}
|
|
121
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
86
122
|
*/
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
123
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
124
|
+
/**
|
|
125
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
126
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
127
|
+
*/
|
|
128
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
129
|
+
targetId?: string;
|
|
130
|
+
}, options?: O): RestResponse<void>;
|
|
131
|
+
/**
|
|
132
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
133
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
134
|
+
*/
|
|
135
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
136
|
+
targetId?: string;
|
|
137
|
+
}, options?: O): RestResponse<void>;
|
|
96
138
|
}
|
|
97
139
|
export declare class AgentResourceClient<O> {
|
|
98
140
|
protected httpClient: HttpClient<O>;
|
|
@@ -120,29 +162,6 @@ export declare class AgentResourceClient<O> {
|
|
|
120
162
|
realm?: string;
|
|
121
163
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
122
164
|
}
|
|
123
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
124
|
-
protected httpClient: HttpClient<O>;
|
|
125
|
-
constructor(httpClient: HttpClient<O>);
|
|
126
|
-
/**
|
|
127
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
128
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
129
|
-
*/
|
|
130
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
131
|
-
/**
|
|
132
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
133
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
134
|
-
*/
|
|
135
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
136
|
-
}
|
|
137
|
-
export declare class ConsoleResourceClient<O> {
|
|
138
|
-
protected httpClient: HttpClient<O>;
|
|
139
|
-
constructor(httpClient: HttpClient<O>);
|
|
140
|
-
/**
|
|
141
|
-
* HTTP POST /console/register
|
|
142
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
143
|
-
*/
|
|
144
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
145
|
-
}
|
|
146
165
|
export declare class AppResourceClient<O> {
|
|
147
166
|
protected httpClient: HttpClient<O>;
|
|
148
167
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -162,25 +181,6 @@ export declare class AppResourceClient<O> {
|
|
|
162
181
|
*/
|
|
163
182
|
getAppInfos(options?: O): RestResponse<any>;
|
|
164
183
|
}
|
|
165
|
-
export declare class FlowResourceClient<O> {
|
|
166
|
-
protected httpClient: HttpClient<O>;
|
|
167
|
-
constructor(httpClient: HttpClient<O>);
|
|
168
|
-
/**
|
|
169
|
-
* HTTP GET /flow
|
|
170
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
171
|
-
*/
|
|
172
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
173
|
-
/**
|
|
174
|
-
* HTTP GET /flow/{name}
|
|
175
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
176
|
-
*/
|
|
177
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
178
|
-
/**
|
|
179
|
-
* HTTP GET /flow/{type}
|
|
180
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
181
|
-
*/
|
|
182
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
183
|
-
}
|
|
184
184
|
export declare class AlarmResourceClient<O> {
|
|
185
185
|
protected httpClient: HttpClient<O>;
|
|
186
186
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -234,247 +234,115 @@ export declare class AlarmResourceClient<O> {
|
|
|
234
234
|
realm?: string;
|
|
235
235
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
236
236
|
}
|
|
237
|
-
export declare class
|
|
238
|
-
protected httpClient: HttpClient<O>;
|
|
239
|
-
constructor(httpClient: HttpClient<O>);
|
|
240
|
-
/**
|
|
241
|
-
* HTTP GET /health
|
|
242
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
243
|
-
*/
|
|
244
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
245
|
-
[index: string]: any;
|
|
246
|
-
}>;
|
|
247
|
-
/**
|
|
248
|
-
* HTTP GET /info
|
|
249
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
250
|
-
*/
|
|
251
|
-
getInfo(options?: O): RestResponse<{
|
|
252
|
-
[index: string]: any;
|
|
253
|
-
}>;
|
|
254
|
-
}
|
|
255
|
-
export declare class ConfigurationResourceClient<O> {
|
|
256
|
-
protected httpClient: HttpClient<O>;
|
|
257
|
-
constructor(httpClient: HttpClient<O>);
|
|
258
|
-
/**
|
|
259
|
-
* HTTP GET /configuration/manager
|
|
260
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
261
|
-
*/
|
|
262
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
263
|
-
/**
|
|
264
|
-
* HTTP PUT /configuration/manager
|
|
265
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
266
|
-
*/
|
|
267
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
268
|
-
/**
|
|
269
|
-
* HTTP POST /configuration/manager/file
|
|
270
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
271
|
-
*/
|
|
272
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
273
|
-
path?: string;
|
|
274
|
-
}, options?: O): RestResponse<string>;
|
|
275
|
-
/**
|
|
276
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
277
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
278
|
-
*/
|
|
279
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
280
|
-
}
|
|
281
|
-
export declare class AssetResourceClient<O> {
|
|
237
|
+
export declare class AssetModelResourceClient<O> {
|
|
282
238
|
protected httpClient: HttpClient<O>;
|
|
283
239
|
constructor(httpClient: HttpClient<O>);
|
|
284
240
|
/**
|
|
285
|
-
* HTTP
|
|
286
|
-
* Java method: org.openremote.model.asset.
|
|
287
|
-
*/
|
|
288
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
289
|
-
/**
|
|
290
|
-
* HTTP DELETE /asset
|
|
291
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
292
|
-
*/
|
|
293
|
-
delete(queryParams?: {
|
|
294
|
-
assetId?: string[];
|
|
295
|
-
}, options?: O): RestResponse<void>;
|
|
296
|
-
/**
|
|
297
|
-
* HTTP PUT /asset/attributes
|
|
298
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
299
|
-
*/
|
|
300
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
301
|
-
/**
|
|
302
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
303
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
304
|
-
*/
|
|
305
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
306
|
-
/**
|
|
307
|
-
* HTTP DELETE /asset/parent
|
|
308
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
309
|
-
*/
|
|
310
|
-
updateNoneParent(queryParams?: {
|
|
311
|
-
assetIds?: string[];
|
|
312
|
-
}, options?: O): RestResponse<void>;
|
|
313
|
-
/**
|
|
314
|
-
* HTTP GET /asset/partial/{assetId}
|
|
315
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
316
|
-
*/
|
|
317
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
318
|
-
/**
|
|
319
|
-
* HTTP POST /asset/query
|
|
320
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
321
|
-
*/
|
|
322
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
323
|
-
/**
|
|
324
|
-
* HTTP POST /asset/tree
|
|
325
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
326
|
-
*/
|
|
327
|
-
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
328
|
-
/**
|
|
329
|
-
* HTTP GET /asset/user/current
|
|
330
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
331
|
-
*/
|
|
332
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
333
|
-
/**
|
|
334
|
-
* HTTP POST /asset/user/link
|
|
335
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
336
|
-
*/
|
|
337
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
338
|
-
/**
|
|
339
|
-
* HTTP GET /asset/user/link
|
|
340
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
341
|
-
*/
|
|
342
|
-
getUserAssetLinks(queryParams?: {
|
|
343
|
-
realm?: string;
|
|
344
|
-
userId?: string;
|
|
345
|
-
assetId?: string;
|
|
346
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
347
|
-
/**
|
|
348
|
-
* HTTP POST /asset/user/link/delete
|
|
349
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
350
|
-
*/
|
|
351
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
352
|
-
/**
|
|
353
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
354
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
355
|
-
*/
|
|
356
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
357
|
-
/**
|
|
358
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
359
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
360
|
-
*/
|
|
361
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
362
|
-
/**
|
|
363
|
-
* HTTP GET /asset/{assetId}
|
|
364
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
365
|
-
*/
|
|
366
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
367
|
-
/**
|
|
368
|
-
* HTTP PUT /asset/{assetId}
|
|
369
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
370
|
-
*/
|
|
371
|
-
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
372
|
-
/**
|
|
373
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
374
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
375
|
-
*/
|
|
376
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
377
|
-
/**
|
|
378
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
379
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
380
|
-
*/
|
|
381
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
382
|
-
/**
|
|
383
|
-
* HTTP PUT /asset/{parentAssetId}/child
|
|
384
|
-
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
241
|
+
* HTTP GET /model/assetDescriptors
|
|
242
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
385
243
|
*/
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
}
|
|
390
|
-
export declare class DashboardResourceClient<O> {
|
|
391
|
-
protected httpClient: HttpClient<O>;
|
|
392
|
-
constructor(httpClient: HttpClient<O>);
|
|
244
|
+
getAssetDescriptors(queryParams?: {
|
|
245
|
+
parentId?: string;
|
|
246
|
+
parentType?: string;
|
|
247
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
393
248
|
/**
|
|
394
|
-
* HTTP
|
|
395
|
-
* Java method: org.openremote.model.
|
|
249
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
250
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
396
251
|
*/
|
|
397
|
-
|
|
252
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
253
|
+
parentId?: string;
|
|
254
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
398
255
|
/**
|
|
399
|
-
* HTTP
|
|
400
|
-
* Java method: org.openremote.model.
|
|
256
|
+
* HTTP GET /model/assetInfos
|
|
257
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
401
258
|
*/
|
|
402
|
-
|
|
259
|
+
getAssetInfos(queryParams?: {
|
|
260
|
+
parentId?: string;
|
|
261
|
+
parentType?: string;
|
|
262
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
403
263
|
/**
|
|
404
|
-
* HTTP GET /
|
|
405
|
-
* Java method: org.openremote.model.
|
|
264
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
265
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
406
266
|
*/
|
|
407
|
-
|
|
267
|
+
getValueDescriptorSchema(queryParams?: {
|
|
268
|
+
name?: string;
|
|
269
|
+
hash?: string;
|
|
270
|
+
}, options?: O): RestResponse<any>;
|
|
408
271
|
/**
|
|
409
|
-
* HTTP
|
|
410
|
-
* Java method: org.openremote.model.
|
|
272
|
+
* HTTP GET /model/metaItemDescriptors
|
|
273
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
411
274
|
*/
|
|
412
|
-
|
|
275
|
+
getMetaItemDescriptors(queryParams?: {
|
|
276
|
+
parentId?: string;
|
|
277
|
+
}, options?: O): RestResponse<{
|
|
278
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
279
|
+
}>;
|
|
413
280
|
/**
|
|
414
|
-
* HTTP
|
|
415
|
-
* Java method: org.openremote.model.
|
|
281
|
+
* HTTP GET /model/valueDescriptors
|
|
282
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
416
283
|
*/
|
|
417
|
-
|
|
284
|
+
getValueDescriptors(queryParams?: {
|
|
285
|
+
parentId?: string;
|
|
286
|
+
}, options?: O): RestResponse<{
|
|
287
|
+
[index: string]: Model.ValueDescriptor;
|
|
288
|
+
}>;
|
|
289
|
+
}
|
|
290
|
+
export declare class ConsoleResourceClient<O> {
|
|
291
|
+
protected httpClient: HttpClient<O>;
|
|
292
|
+
constructor(httpClient: HttpClient<O>);
|
|
418
293
|
/**
|
|
419
|
-
* HTTP
|
|
420
|
-
* Java method: org.openremote.model.
|
|
294
|
+
* HTTP POST /console/register
|
|
295
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
421
296
|
*/
|
|
422
|
-
|
|
297
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
423
298
|
}
|
|
424
|
-
export declare class
|
|
299
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
425
300
|
protected httpClient: HttpClient<O>;
|
|
426
301
|
constructor(httpClient: HttpClient<O>);
|
|
427
302
|
/**
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
303
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
304
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
431
305
|
*/
|
|
432
|
-
|
|
433
|
-
realm?: string;
|
|
434
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
306
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
435
307
|
/**
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
* Response code 409 - ExternalService instance already registered
|
|
439
|
-
* HTTP POST /service
|
|
440
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
308
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
309
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
441
310
|
*/
|
|
442
|
-
|
|
311
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
312
|
+
}
|
|
313
|
+
export declare class RealmResourceClient<O> {
|
|
314
|
+
protected httpClient: HttpClient<O>;
|
|
315
|
+
constructor(httpClient: HttpClient<O>);
|
|
443
316
|
/**
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
317
|
+
* HTTP POST /realm
|
|
318
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
447
319
|
*/
|
|
448
|
-
|
|
320
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
449
321
|
/**
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
* Response code 409 - ExternalService instance already registered
|
|
453
|
-
* HTTP POST /service/global
|
|
454
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
322
|
+
* HTTP GET /realm
|
|
323
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
455
324
|
*/
|
|
456
|
-
|
|
325
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
457
326
|
/**
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
461
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
327
|
+
* HTTP GET /realm/accessible
|
|
328
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
462
329
|
*/
|
|
463
|
-
|
|
330
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
464
331
|
/**
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
468
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
332
|
+
* HTTP DELETE /realm/{name}
|
|
333
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
469
334
|
*/
|
|
470
|
-
|
|
335
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
471
336
|
/**
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
475
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
337
|
+
* HTTP GET /realm/{name}
|
|
338
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
476
339
|
*/
|
|
477
|
-
|
|
340
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
341
|
+
/**
|
|
342
|
+
* HTTP PUT /realm/{name}
|
|
343
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
344
|
+
*/
|
|
345
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
478
346
|
}
|
|
479
347
|
export declare class ProvisioningResourceClient<O> {
|
|
480
348
|
protected httpClient: HttpClient<O>;
|
|
@@ -500,31 +368,31 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
500
368
|
*/
|
|
501
369
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
502
370
|
}
|
|
503
|
-
export declare class
|
|
371
|
+
export declare class ConfigurationResourceClient<O> {
|
|
504
372
|
protected httpClient: HttpClient<O>;
|
|
505
373
|
constructor(httpClient: HttpClient<O>);
|
|
506
374
|
/**
|
|
507
|
-
* HTTP GET /
|
|
508
|
-
* Java method: org.openremote.model.
|
|
375
|
+
* HTTP GET /configuration/manager
|
|
376
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
509
377
|
*/
|
|
510
|
-
|
|
511
|
-
attributeRefs?: string;
|
|
512
|
-
fromTimestamp?: number;
|
|
513
|
-
toTimestamp?: number;
|
|
514
|
-
}, options?: O): RestResponse<any>;
|
|
378
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
515
379
|
/**
|
|
516
|
-
* HTTP
|
|
517
|
-
* Java method: org.openremote.model.
|
|
380
|
+
* HTTP PUT /configuration/manager
|
|
381
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
518
382
|
*/
|
|
519
|
-
|
|
520
|
-
assetId?: string;
|
|
521
|
-
attributeName?: string;
|
|
522
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
383
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
523
384
|
/**
|
|
524
|
-
* HTTP POST /
|
|
525
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP POST /configuration/manager/file
|
|
386
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
526
387
|
*/
|
|
527
|
-
|
|
388
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
389
|
+
path?: string;
|
|
390
|
+
}, options?: O): RestResponse<string>;
|
|
391
|
+
/**
|
|
392
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
393
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
394
|
+
*/
|
|
395
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
528
396
|
}
|
|
529
397
|
export declare class UserResourceClient<O> {
|
|
530
398
|
protected httpClient: HttpClient<O>;
|
|
@@ -648,124 +516,227 @@ export declare class UserResourceClient<O> {
|
|
|
648
516
|
* HTTP GET /user/{realm}/{userId}
|
|
649
517
|
* Java method: org.openremote.model.security.UserResource.get
|
|
650
518
|
*/
|
|
651
|
-
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
519
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
520
|
+
}
|
|
521
|
+
export declare class AssetResourceClient<O> {
|
|
522
|
+
protected httpClient: HttpClient<O>;
|
|
523
|
+
constructor(httpClient: HttpClient<O>);
|
|
524
|
+
/**
|
|
525
|
+
* HTTP POST /asset
|
|
526
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
527
|
+
*/
|
|
528
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
529
|
+
/**
|
|
530
|
+
* HTTP DELETE /asset
|
|
531
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
532
|
+
*/
|
|
533
|
+
delete(queryParams?: {
|
|
534
|
+
assetId?: string[];
|
|
535
|
+
}, options?: O): RestResponse<void>;
|
|
536
|
+
/**
|
|
537
|
+
* HTTP PUT /asset/attributes
|
|
538
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
539
|
+
*/
|
|
540
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
541
|
+
/**
|
|
542
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
543
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
544
|
+
*/
|
|
545
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
546
|
+
/**
|
|
547
|
+
* HTTP DELETE /asset/parent
|
|
548
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
549
|
+
*/
|
|
550
|
+
updateNoneParent(queryParams?: {
|
|
551
|
+
assetIds?: string[];
|
|
552
|
+
}, options?: O): RestResponse<void>;
|
|
553
|
+
/**
|
|
554
|
+
* HTTP GET /asset/partial/{assetId}
|
|
555
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
556
|
+
*/
|
|
557
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
558
|
+
/**
|
|
559
|
+
* HTTP POST /asset/query
|
|
560
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
561
|
+
*/
|
|
562
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
563
|
+
/**
|
|
564
|
+
* HTTP POST /asset/tree
|
|
565
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
566
|
+
*/
|
|
567
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
568
|
+
/**
|
|
569
|
+
* HTTP GET /asset/user/current
|
|
570
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
571
|
+
*/
|
|
572
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
573
|
+
/**
|
|
574
|
+
* HTTP POST /asset/user/link
|
|
575
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
576
|
+
*/
|
|
577
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
578
|
+
/**
|
|
579
|
+
* HTTP GET /asset/user/link
|
|
580
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
581
|
+
*/
|
|
582
|
+
getUserAssetLinks(queryParams?: {
|
|
583
|
+
realm?: string;
|
|
584
|
+
userId?: string;
|
|
585
|
+
assetId?: string;
|
|
586
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
587
|
+
/**
|
|
588
|
+
* HTTP POST /asset/user/link/delete
|
|
589
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
590
|
+
*/
|
|
591
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
592
|
+
/**
|
|
593
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
594
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
595
|
+
*/
|
|
596
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
597
|
+
/**
|
|
598
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
599
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
600
|
+
*/
|
|
601
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
602
|
+
/**
|
|
603
|
+
* HTTP GET /asset/{assetId}
|
|
604
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
605
|
+
*/
|
|
606
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
607
|
+
/**
|
|
608
|
+
* HTTP PUT /asset/{assetId}
|
|
609
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
610
|
+
*/
|
|
611
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
612
|
+
/**
|
|
613
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
614
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
615
|
+
*/
|
|
616
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
617
|
+
/**
|
|
618
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
619
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
620
|
+
*/
|
|
621
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
622
|
+
/**
|
|
623
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
624
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
625
|
+
*/
|
|
626
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
627
|
+
assetIds?: string[];
|
|
628
|
+
}, options?: O): RestResponse<void>;
|
|
629
|
+
}
|
|
630
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
631
|
+
protected httpClient: HttpClient<O>;
|
|
632
|
+
constructor(httpClient: HttpClient<O>);
|
|
633
|
+
/**
|
|
634
|
+
* HTTP GET /asset/datapoint/export
|
|
635
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
636
|
+
*/
|
|
637
|
+
getDatapointExport(queryParams?: {
|
|
638
|
+
attributeRefs?: string;
|
|
639
|
+
fromTimestamp?: number;
|
|
640
|
+
toTimestamp?: number;
|
|
641
|
+
}, options?: O): RestResponse<any>;
|
|
642
|
+
/**
|
|
643
|
+
* HTTP GET /asset/datapoint/periods
|
|
644
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
645
|
+
*/
|
|
646
|
+
getDatapointPeriod(queryParams?: {
|
|
647
|
+
assetId?: string;
|
|
648
|
+
attributeName?: string;
|
|
649
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
650
|
+
/**
|
|
651
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
652
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
653
|
+
*/
|
|
654
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
652
655
|
}
|
|
653
|
-
export declare class
|
|
656
|
+
export declare class SyslogResourceClient<O> {
|
|
654
657
|
protected httpClient: HttpClient<O>;
|
|
655
658
|
constructor(httpClient: HttpClient<O>);
|
|
656
659
|
/**
|
|
657
|
-
* HTTP
|
|
658
|
-
* Java method: org.openremote.model.
|
|
659
|
-
*/
|
|
660
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
661
|
-
/**
|
|
662
|
-
* HTTP DELETE /gateway/tunnel
|
|
663
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
660
|
+
* HTTP GET /syslog/config
|
|
661
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
664
662
|
*/
|
|
665
|
-
|
|
663
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
666
664
|
/**
|
|
667
|
-
* HTTP
|
|
668
|
-
* Java method: org.openremote.model.
|
|
665
|
+
* HTTP PUT /syslog/config
|
|
666
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
669
667
|
*/
|
|
670
|
-
|
|
668
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
671
669
|
/**
|
|
672
|
-
* HTTP
|
|
673
|
-
* Java method: org.openremote.model.
|
|
670
|
+
* HTTP DELETE /syslog/event
|
|
671
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
674
672
|
*/
|
|
675
|
-
|
|
673
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
676
674
|
/**
|
|
677
|
-
* HTTP GET /
|
|
678
|
-
* Java method: org.openremote.model.
|
|
675
|
+
* HTTP GET /syslog/event
|
|
676
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
679
677
|
*/
|
|
680
|
-
|
|
678
|
+
getEvents(queryParams?: {
|
|
679
|
+
level?: Model.SyslogLevel;
|
|
680
|
+
per_page?: number;
|
|
681
|
+
page?: number;
|
|
682
|
+
from?: number;
|
|
683
|
+
to?: number;
|
|
684
|
+
category?: Model.SyslogCategory[];
|
|
685
|
+
subCategory?: string[];
|
|
686
|
+
}, options?: O): RestResponse<any>;
|
|
681
687
|
}
|
|
682
|
-
export declare class
|
|
688
|
+
export declare class FlowResourceClient<O> {
|
|
683
689
|
protected httpClient: HttpClient<O>;
|
|
684
690
|
constructor(httpClient: HttpClient<O>);
|
|
685
691
|
/**
|
|
686
|
-
* HTTP GET /
|
|
687
|
-
* Java method: org.openremote.model.
|
|
688
|
-
*/
|
|
689
|
-
getNotifications(queryParams?: {
|
|
690
|
-
id?: number;
|
|
691
|
-
type?: string;
|
|
692
|
-
from?: number;
|
|
693
|
-
to?: number;
|
|
694
|
-
realmId?: string;
|
|
695
|
-
userId?: string;
|
|
696
|
-
assetId?: string;
|
|
697
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
698
|
-
/**
|
|
699
|
-
* HTTP DELETE /notification
|
|
700
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
701
|
-
*/
|
|
702
|
-
removeNotifications(queryParams?: {
|
|
703
|
-
id?: number;
|
|
704
|
-
type?: string;
|
|
705
|
-
from?: number;
|
|
706
|
-
to?: number;
|
|
707
|
-
realmId?: string;
|
|
708
|
-
userId?: string;
|
|
709
|
-
assetId?: string;
|
|
710
|
-
}, options?: O): RestResponse<void>;
|
|
711
|
-
/**
|
|
712
|
-
* HTTP POST /notification/alert
|
|
713
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
714
|
-
*/
|
|
715
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
716
|
-
/**
|
|
717
|
-
* HTTP DELETE /notification/{notificationId}
|
|
718
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
692
|
+
* HTTP GET /flow
|
|
693
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
719
694
|
*/
|
|
720
|
-
|
|
695
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
721
696
|
/**
|
|
722
|
-
* HTTP
|
|
723
|
-
* Java method: org.openremote.model.
|
|
697
|
+
* HTTP GET /flow/{name}
|
|
698
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
724
699
|
*/
|
|
725
|
-
|
|
726
|
-
targetId?: string;
|
|
727
|
-
}, options?: O): RestResponse<void>;
|
|
700
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
728
701
|
/**
|
|
729
|
-
* HTTP
|
|
730
|
-
* Java method: org.openremote.model.
|
|
702
|
+
* HTTP GET /flow/{type}
|
|
703
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
731
704
|
*/
|
|
732
|
-
|
|
733
|
-
targetId?: string;
|
|
734
|
-
}, options?: O): RestResponse<void>;
|
|
705
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
735
706
|
}
|
|
736
|
-
export declare class
|
|
707
|
+
export declare class DashboardResourceClient<O> {
|
|
737
708
|
protected httpClient: HttpClient<O>;
|
|
738
709
|
constructor(httpClient: HttpClient<O>);
|
|
739
710
|
/**
|
|
740
|
-
* HTTP POST /
|
|
741
|
-
* Java method: org.openremote.model.
|
|
711
|
+
* HTTP POST /dashboard
|
|
712
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
742
713
|
*/
|
|
743
|
-
create(
|
|
714
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
744
715
|
/**
|
|
745
|
-
* HTTP
|
|
746
|
-
* Java method: org.openremote.model.
|
|
716
|
+
* HTTP PUT /dashboard
|
|
717
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
747
718
|
*/
|
|
748
|
-
|
|
719
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
749
720
|
/**
|
|
750
|
-
* HTTP GET /realm
|
|
751
|
-
* Java method: org.openremote.model.
|
|
721
|
+
* HTTP GET /dashboard/all/{realm}
|
|
722
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
752
723
|
*/
|
|
753
|
-
|
|
724
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
754
725
|
/**
|
|
755
|
-
* HTTP
|
|
756
|
-
* Java method: org.openremote.model.
|
|
726
|
+
* HTTP POST /dashboard/query
|
|
727
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
757
728
|
*/
|
|
758
|
-
|
|
729
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
759
730
|
/**
|
|
760
|
-
* HTTP
|
|
761
|
-
* Java method: org.openremote.model.
|
|
731
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
732
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
762
733
|
*/
|
|
763
|
-
|
|
734
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
764
735
|
/**
|
|
765
|
-
* HTTP
|
|
766
|
-
* Java method: org.openremote.model.
|
|
736
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
737
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
767
738
|
*/
|
|
768
|
-
|
|
739
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
769
740
|
}
|
|
770
741
|
export declare class RulesResourceClient<O> {
|
|
771
742
|
protected httpClient: HttpClient<O>;
|
|
@@ -875,6 +846,35 @@ export declare class RulesResourceClient<O> {
|
|
|
875
846
|
*/
|
|
876
847
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
877
848
|
}
|
|
849
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
850
|
+
protected httpClient: HttpClient<O>;
|
|
851
|
+
constructor(httpClient: HttpClient<O>);
|
|
852
|
+
/**
|
|
853
|
+
* HTTP POST /gateway/tunnel
|
|
854
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
855
|
+
*/
|
|
856
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
857
|
+
/**
|
|
858
|
+
* HTTP DELETE /gateway/tunnel
|
|
859
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
860
|
+
*/
|
|
861
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
862
|
+
/**
|
|
863
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
864
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
865
|
+
*/
|
|
866
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
867
|
+
/**
|
|
868
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
869
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
870
|
+
*/
|
|
871
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
872
|
+
/**
|
|
873
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
874
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
875
|
+
*/
|
|
876
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
877
|
+
}
|
|
878
878
|
export declare class MapResourceClient<O> {
|
|
879
879
|
protected httpClient: HttpClient<O>;
|
|
880
880
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -966,49 +966,49 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
-
protected
|
|
970
|
-
protected
|
|
969
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
970
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
971
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
971
972
|
protected _agentResource: AxiosAgentResourceClient;
|
|
972
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
973
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
974
973
|
protected _appResource: AxiosAppResourceClient;
|
|
975
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
976
974
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
977
|
-
protected
|
|
975
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
976
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
977
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
978
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
979
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
978
980
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
981
|
+
protected _userResource: AxiosUserResourceClient;
|
|
979
982
|
protected _assetResource: AxiosAssetResourceClient;
|
|
980
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
981
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
982
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
983
983
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
984
|
-
protected
|
|
985
|
-
protected
|
|
986
|
-
protected
|
|
987
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
984
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
985
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
986
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
988
987
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
988
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
989
989
|
protected _mapResource: AxiosMapResourceClient;
|
|
990
990
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
get
|
|
993
|
-
get
|
|
992
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
993
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
994
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
994
995
|
get AgentResource(): AxiosAgentResourceClient;
|
|
995
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
996
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
997
996
|
get AppResource(): AxiosAppResourceClient;
|
|
998
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
999
997
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1000
|
-
get
|
|
998
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
999
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1000
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1001
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1002
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1001
1003
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1004
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1002
1005
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1003
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1004
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1005
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1006
1006
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1007
|
-
get
|
|
1008
|
-
get
|
|
1009
|
-
get
|
|
1010
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1007
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1008
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1009
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1011
1010
|
get RulesResource(): AxiosRulesResourceClient;
|
|
1011
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1012
1012
|
get MapResource(): AxiosMapResourceClient;
|
|
1013
1013
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1014
1014
|
}
|
|
@@ -1018,64 +1018,64 @@ declare module "axios" {
|
|
|
1018
1018
|
data: R;
|
|
1019
1019
|
}
|
|
1020
1020
|
}
|
|
1021
|
-
export declare class
|
|
1021
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
|
-
export declare class
|
|
1027
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
|
-
export declare class
|
|
1030
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1033
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1035
|
}
|
|
1036
|
-
export declare class
|
|
1036
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1038
|
}
|
|
1039
|
-
export declare class
|
|
1039
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1041
|
}
|
|
1042
|
-
export declare class
|
|
1042
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1044
|
}
|
|
1045
|
-
export declare class
|
|
1045
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1047
|
}
|
|
1048
|
-
export declare class
|
|
1048
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1050
|
}
|
|
1051
|
-
export declare class
|
|
1051
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1053
|
}
|
|
1054
|
-
export declare class
|
|
1054
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1056
|
}
|
|
1057
|
-
export declare class
|
|
1057
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1059
|
}
|
|
1060
|
-
export declare class
|
|
1060
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1062
|
}
|
|
1063
1063
|
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1065
|
}
|
|
1066
|
-
export declare class
|
|
1066
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1068
|
}
|
|
1069
|
-
export declare class
|
|
1069
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1071
|
}
|
|
1072
|
-
export declare class
|
|
1072
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1074
|
}
|
|
1075
|
-
export declare class
|
|
1075
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<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
1081
|
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|