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