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