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