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