@openremote/rest 1.3.0-snapshot.20250219152724 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +476 -476
- 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,6 +9,200 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class StatusResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP GET /health
|
|
17
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
18
|
+
*/
|
|
19
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
20
|
+
[index: string]: any;
|
|
21
|
+
}>;
|
|
22
|
+
/**
|
|
23
|
+
* HTTP GET /info
|
|
24
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
25
|
+
*/
|
|
26
|
+
getInfo(options?: O): RestResponse<{
|
|
27
|
+
[index: string]: any;
|
|
28
|
+
}>;
|
|
29
|
+
}
|
|
30
|
+
export declare class UserResourceClient<O> {
|
|
31
|
+
protected httpClient: HttpClient<O>;
|
|
32
|
+
constructor(httpClient: HttpClient<O>);
|
|
33
|
+
/**
|
|
34
|
+
* HTTP PUT /user/locale
|
|
35
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
36
|
+
*/
|
|
37
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
38
|
+
/**
|
|
39
|
+
* HTTP POST /user/query
|
|
40
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
41
|
+
*/
|
|
42
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
43
|
+
/**
|
|
44
|
+
* HTTP GET /user/user
|
|
45
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
46
|
+
*/
|
|
47
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
48
|
+
/**
|
|
49
|
+
* HTTP GET /user/userRealmRoles
|
|
50
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
51
|
+
*/
|
|
52
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<Model.Role[]>;
|
|
53
|
+
/**
|
|
54
|
+
* HTTP GET /user/userRoles
|
|
55
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRoles
|
|
56
|
+
*/
|
|
57
|
+
getCurrentUserRoles(options?: O): RestResponse<Model.Role[]>;
|
|
58
|
+
/**
|
|
59
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
60
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
61
|
+
*/
|
|
62
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
63
|
+
/**
|
|
64
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
65
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
66
|
+
*/
|
|
67
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
68
|
+
/**
|
|
69
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
70
|
+
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
71
|
+
*/
|
|
72
|
+
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
73
|
+
/**
|
|
74
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
75
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
76
|
+
*/
|
|
77
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
78
|
+
/**
|
|
79
|
+
* HTTP GET /user/{realm}/roles
|
|
80
|
+
* Java method: org.openremote.model.security.UserResource.getRoles
|
|
81
|
+
*/
|
|
82
|
+
getRoles(realm: string, options?: O): RestResponse<Model.Role[]>;
|
|
83
|
+
/**
|
|
84
|
+
* HTTP PUT /user/{realm}/roles
|
|
85
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
86
|
+
*/
|
|
87
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
88
|
+
/**
|
|
89
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
90
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
91
|
+
*/
|
|
92
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
93
|
+
/**
|
|
94
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
95
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
96
|
+
*/
|
|
97
|
+
updateUserRealmRoles(realm: string, userId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
98
|
+
/**
|
|
99
|
+
* HTTP GET /user/{realm}/userRoles/{userId}
|
|
100
|
+
* Java method: org.openremote.model.security.UserResource.getUserRoles
|
|
101
|
+
*/
|
|
102
|
+
getUserRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
103
|
+
/**
|
|
104
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}
|
|
105
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRoles
|
|
106
|
+
*/
|
|
107
|
+
updateUserRoles(realm: string, userId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
108
|
+
/**
|
|
109
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
110
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
111
|
+
*/
|
|
112
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
113
|
+
/**
|
|
114
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
115
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
116
|
+
*/
|
|
117
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
118
|
+
/**
|
|
119
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
120
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
121
|
+
*/
|
|
122
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
123
|
+
/**
|
|
124
|
+
* HTTP POST /user/{realm}/users
|
|
125
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
126
|
+
*/
|
|
127
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
128
|
+
/**
|
|
129
|
+
* HTTP PUT /user/{realm}/users
|
|
130
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
131
|
+
*/
|
|
132
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
133
|
+
/**
|
|
134
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
135
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
136
|
+
*/
|
|
137
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
138
|
+
/**
|
|
139
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
140
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
141
|
+
*/
|
|
142
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
143
|
+
/**
|
|
144
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
145
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
146
|
+
*/
|
|
147
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
148
|
+
/**
|
|
149
|
+
* HTTP GET /user/{realm}/{userId}
|
|
150
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
151
|
+
*/
|
|
152
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
153
|
+
}
|
|
154
|
+
export declare class AgentResourceClient<O> {
|
|
155
|
+
protected httpClient: HttpClient<O>;
|
|
156
|
+
constructor(httpClient: HttpClient<O>);
|
|
157
|
+
/**
|
|
158
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
159
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
160
|
+
*/
|
|
161
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
162
|
+
realm?: string;
|
|
163
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
164
|
+
/**
|
|
165
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
166
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
167
|
+
*/
|
|
168
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
169
|
+
realm?: string;
|
|
170
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
171
|
+
/**
|
|
172
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
173
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
174
|
+
*/
|
|
175
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
176
|
+
parentId?: string;
|
|
177
|
+
realm?: string;
|
|
178
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
179
|
+
}
|
|
180
|
+
export declare class ConfigurationResourceClient<O> {
|
|
181
|
+
protected httpClient: HttpClient<O>;
|
|
182
|
+
constructor(httpClient: HttpClient<O>);
|
|
183
|
+
/**
|
|
184
|
+
* HTTP GET /configuration/manager
|
|
185
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
186
|
+
*/
|
|
187
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
188
|
+
/**
|
|
189
|
+
* HTTP PUT /configuration/manager
|
|
190
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
191
|
+
*/
|
|
192
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
193
|
+
/**
|
|
194
|
+
* HTTP POST /configuration/manager/file
|
|
195
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
196
|
+
*/
|
|
197
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
198
|
+
path?: string;
|
|
199
|
+
}, options?: O): RestResponse<string>;
|
|
200
|
+
/**
|
|
201
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
202
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
203
|
+
*/
|
|
204
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
205
|
+
}
|
|
12
206
|
export declare class RulesResourceClient<O> {
|
|
13
207
|
protected httpClient: HttpClient<O>;
|
|
14
208
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -117,113 +311,51 @@ export declare class RulesResourceClient<O> {
|
|
|
117
311
|
*/
|
|
118
312
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
119
313
|
}
|
|
120
|
-
export declare class
|
|
314
|
+
export declare class DashboardResourceClient<O> {
|
|
121
315
|
protected httpClient: HttpClient<O>;
|
|
122
316
|
constructor(httpClient: HttpClient<O>);
|
|
123
317
|
/**
|
|
124
|
-
* HTTP POST /
|
|
125
|
-
* Java method: org.openremote.model.
|
|
318
|
+
* HTTP POST /dashboard
|
|
319
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
126
320
|
*/
|
|
127
|
-
|
|
321
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
128
322
|
/**
|
|
129
|
-
* HTTP PUT /
|
|
130
|
-
* Java method: org.openremote.model.
|
|
323
|
+
* HTTP PUT /dashboard
|
|
324
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
131
325
|
*/
|
|
132
|
-
|
|
133
|
-
}
|
|
134
|
-
export declare class AgentResourceClient<O> {
|
|
135
|
-
protected httpClient: HttpClient<O>;
|
|
136
|
-
constructor(httpClient: HttpClient<O>);
|
|
326
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
137
327
|
/**
|
|
138
|
-
* HTTP GET /
|
|
139
|
-
* Java method: org.openremote.model.
|
|
328
|
+
* HTTP GET /dashboard/all/{realm}
|
|
329
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
140
330
|
*/
|
|
141
|
-
|
|
142
|
-
realm?: string;
|
|
143
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
331
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
144
332
|
/**
|
|
145
|
-
* HTTP POST /
|
|
146
|
-
* Java method: org.openremote.model.
|
|
333
|
+
* HTTP POST /dashboard/query
|
|
334
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
147
335
|
*/
|
|
148
|
-
|
|
149
|
-
realm?: string;
|
|
150
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
336
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
151
337
|
/**
|
|
152
|
-
* HTTP
|
|
153
|
-
* Java method: org.openremote.model.
|
|
338
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
339
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
154
340
|
*/
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
341
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
342
|
+
/**
|
|
343
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
344
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
345
|
+
*/
|
|
346
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
159
347
|
}
|
|
160
|
-
export declare class
|
|
348
|
+
export declare class AssetResourceClient<O> {
|
|
161
349
|
protected httpClient: HttpClient<O>;
|
|
162
350
|
constructor(httpClient: HttpClient<O>);
|
|
163
351
|
/**
|
|
164
|
-
* HTTP
|
|
165
|
-
* Java method: org.openremote.model.
|
|
352
|
+
* HTTP POST /asset
|
|
353
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
166
354
|
*/
|
|
167
|
-
|
|
355
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
168
356
|
/**
|
|
169
|
-
* HTTP
|
|
170
|
-
* Java method: org.openremote.model.
|
|
171
|
-
*/
|
|
172
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
173
|
-
/**
|
|
174
|
-
* HTTP DELETE /syslog/event
|
|
175
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
176
|
-
*/
|
|
177
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
178
|
-
/**
|
|
179
|
-
* HTTP GET /syslog/event
|
|
180
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
181
|
-
*/
|
|
182
|
-
getEvents(queryParams?: {
|
|
183
|
-
level?: Model.SyslogLevel;
|
|
184
|
-
per_page?: number;
|
|
185
|
-
page?: number;
|
|
186
|
-
from?: number;
|
|
187
|
-
to?: number;
|
|
188
|
-
category?: Model.SyslogCategory[];
|
|
189
|
-
subCategory?: string[];
|
|
190
|
-
}, options?: O): RestResponse<any>;
|
|
191
|
-
}
|
|
192
|
-
export declare class ProvisioningResourceClient<O> {
|
|
193
|
-
protected httpClient: HttpClient<O>;
|
|
194
|
-
constructor(httpClient: HttpClient<O>);
|
|
195
|
-
/**
|
|
196
|
-
* HTTP POST /provisioning
|
|
197
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
198
|
-
*/
|
|
199
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
200
|
-
/**
|
|
201
|
-
* HTTP GET /provisioning
|
|
202
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
203
|
-
*/
|
|
204
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
205
|
-
/**
|
|
206
|
-
* HTTP DELETE /provisioning/{id}
|
|
207
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
208
|
-
*/
|
|
209
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
210
|
-
/**
|
|
211
|
-
* HTTP PUT /provisioning/{id}
|
|
212
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
213
|
-
*/
|
|
214
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
215
|
-
}
|
|
216
|
-
export declare class AssetResourceClient<O> {
|
|
217
|
-
protected httpClient: HttpClient<O>;
|
|
218
|
-
constructor(httpClient: HttpClient<O>);
|
|
219
|
-
/**
|
|
220
|
-
* HTTP POST /asset
|
|
221
|
-
* Java method: org.openremote.model.asset.AssetResource.create
|
|
222
|
-
*/
|
|
223
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
224
|
-
/**
|
|
225
|
-
* HTTP DELETE /asset
|
|
226
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
357
|
+
* HTTP DELETE /asset
|
|
358
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
227
359
|
*/
|
|
228
360
|
delete(queryParams?: {
|
|
229
361
|
assetId?: string[];
|
|
@@ -317,378 +449,244 @@ export declare class AssetResourceClient<O> {
|
|
|
317
449
|
assetIds?: string[];
|
|
318
450
|
}, options?: O): RestResponse<void>;
|
|
319
451
|
}
|
|
320
|
-
export declare class
|
|
321
|
-
protected httpClient: HttpClient<O>;
|
|
322
|
-
constructor(httpClient: HttpClient<O>);
|
|
323
|
-
/**
|
|
324
|
-
* HTTP GET /configuration/manager
|
|
325
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
326
|
-
*/
|
|
327
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
328
|
-
/**
|
|
329
|
-
* HTTP PUT /configuration/manager
|
|
330
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
331
|
-
*/
|
|
332
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
333
|
-
/**
|
|
334
|
-
* HTTP POST /configuration/manager/file
|
|
335
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
336
|
-
*/
|
|
337
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
338
|
-
path?: string;
|
|
339
|
-
}, options?: O): RestResponse<string>;
|
|
340
|
-
/**
|
|
341
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
342
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
343
|
-
*/
|
|
344
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
345
|
-
}
|
|
346
|
-
export declare class DashboardResourceClient<O> {
|
|
452
|
+
export declare class RealmResourceClient<O> {
|
|
347
453
|
protected httpClient: HttpClient<O>;
|
|
348
454
|
constructor(httpClient: HttpClient<O>);
|
|
349
455
|
/**
|
|
350
|
-
* HTTP POST /
|
|
351
|
-
* Java method: org.openremote.model.
|
|
456
|
+
* HTTP POST /realm
|
|
457
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
352
458
|
*/
|
|
353
|
-
create(
|
|
459
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
354
460
|
/**
|
|
355
|
-
* HTTP
|
|
356
|
-
* Java method: org.openremote.model.
|
|
461
|
+
* HTTP GET /realm
|
|
462
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
357
463
|
*/
|
|
358
|
-
|
|
464
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
359
465
|
/**
|
|
360
|
-
* HTTP GET /
|
|
361
|
-
* Java method: org.openremote.model.
|
|
466
|
+
* HTTP GET /realm/accessible
|
|
467
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
362
468
|
*/
|
|
363
|
-
|
|
469
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
364
470
|
/**
|
|
365
|
-
* HTTP
|
|
366
|
-
* Java method: org.openremote.model.
|
|
471
|
+
* HTTP DELETE /realm/{name}
|
|
472
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
367
473
|
*/
|
|
368
|
-
|
|
474
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
369
475
|
/**
|
|
370
|
-
* HTTP
|
|
371
|
-
* Java method: org.openremote.model.
|
|
476
|
+
* HTTP GET /realm/{name}
|
|
477
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
372
478
|
*/
|
|
373
|
-
|
|
479
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
374
480
|
/**
|
|
375
|
-
* HTTP
|
|
376
|
-
* Java method: org.openremote.model.
|
|
481
|
+
* HTTP PUT /realm/{name}
|
|
482
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
377
483
|
*/
|
|
378
|
-
|
|
484
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
379
485
|
}
|
|
380
|
-
export declare class
|
|
486
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
381
487
|
protected httpClient: HttpClient<O>;
|
|
382
488
|
constructor(httpClient: HttpClient<O>);
|
|
383
489
|
/**
|
|
384
|
-
* HTTP
|
|
385
|
-
* Java method: org.openremote.model.
|
|
386
|
-
*/
|
|
387
|
-
getAssetDescriptors(queryParams?: {
|
|
388
|
-
parentId?: string;
|
|
389
|
-
parentType?: string;
|
|
390
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
391
|
-
/**
|
|
392
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
393
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
394
|
-
*/
|
|
395
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
396
|
-
parentId?: string;
|
|
397
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
398
|
-
/**
|
|
399
|
-
* HTTP GET /model/assetInfos
|
|
400
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
401
|
-
*/
|
|
402
|
-
getAssetInfos(queryParams?: {
|
|
403
|
-
parentId?: string;
|
|
404
|
-
parentType?: string;
|
|
405
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
406
|
-
/**
|
|
407
|
-
* HTTP GET /model/metaItemDescriptors
|
|
408
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
490
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
491
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
409
492
|
*/
|
|
410
|
-
|
|
411
|
-
parentId?: string;
|
|
412
|
-
}, options?: O): RestResponse<{
|
|
413
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
414
|
-
}>;
|
|
493
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
415
494
|
/**
|
|
416
|
-
* HTTP
|
|
417
|
-
* Java method: org.openremote.model.
|
|
495
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
496
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
418
497
|
*/
|
|
419
|
-
|
|
420
|
-
parentId?: string;
|
|
421
|
-
}, options?: O): RestResponse<{
|
|
422
|
-
[index: string]: Model.ValueDescriptor;
|
|
423
|
-
}>;
|
|
498
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
424
499
|
}
|
|
425
|
-
export declare class
|
|
500
|
+
export declare class AlarmResourceClient<O> {
|
|
426
501
|
protected httpClient: HttpClient<O>;
|
|
427
502
|
constructor(httpClient: HttpClient<O>);
|
|
428
503
|
/**
|
|
429
|
-
* HTTP
|
|
430
|
-
* Java method: org.openremote.model.
|
|
504
|
+
* HTTP POST /alarm
|
|
505
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
431
506
|
*/
|
|
432
|
-
|
|
507
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
508
|
+
assetIds?: string[];
|
|
509
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
433
510
|
/**
|
|
434
|
-
* HTTP GET /
|
|
435
|
-
* Java method: org.openremote.model.
|
|
511
|
+
* HTTP GET /alarm
|
|
512
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
436
513
|
*/
|
|
437
|
-
|
|
514
|
+
getAlarms(queryParams?: {
|
|
515
|
+
realm?: string;
|
|
516
|
+
status?: Model.AlarmStatus;
|
|
517
|
+
assetId?: string;
|
|
518
|
+
assigneeId?: string;
|
|
519
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
438
520
|
/**
|
|
439
|
-
* HTTP
|
|
440
|
-
* Java method: org.openremote.model.
|
|
521
|
+
* HTTP DELETE /alarm
|
|
522
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
441
523
|
*/
|
|
442
|
-
|
|
443
|
-
}
|
|
444
|
-
export declare class StatusResourceClient<O> {
|
|
445
|
-
protected httpClient: HttpClient<O>;
|
|
446
|
-
constructor(httpClient: HttpClient<O>);
|
|
524
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
447
525
|
/**
|
|
448
|
-
* HTTP
|
|
449
|
-
* Java method: org.openremote.model.
|
|
526
|
+
* HTTP PUT /alarm/assets
|
|
527
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
450
528
|
*/
|
|
451
|
-
|
|
452
|
-
[index: string]: any;
|
|
453
|
-
}>;
|
|
529
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
454
530
|
/**
|
|
455
|
-
* HTTP GET /
|
|
456
|
-
* Java method: org.openremote.model.
|
|
531
|
+
* HTTP GET /alarm/{alarmId}
|
|
532
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
457
533
|
*/
|
|
458
|
-
|
|
459
|
-
[index: string]: any;
|
|
460
|
-
}>;
|
|
461
|
-
}
|
|
462
|
-
export declare class FlowResourceClient<O> {
|
|
463
|
-
protected httpClient: HttpClient<O>;
|
|
464
|
-
constructor(httpClient: HttpClient<O>);
|
|
534
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
465
535
|
/**
|
|
466
|
-
* HTTP
|
|
467
|
-
* Java method: org.openremote.model.
|
|
536
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
537
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
468
538
|
*/
|
|
469
|
-
|
|
539
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
470
540
|
/**
|
|
471
|
-
* HTTP
|
|
472
|
-
* Java method: org.openremote.model.
|
|
541
|
+
* HTTP PUT /alarm/{alarmId}
|
|
542
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
473
543
|
*/
|
|
474
|
-
|
|
544
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
475
545
|
/**
|
|
476
|
-
* HTTP GET /
|
|
477
|
-
* Java method: org.openremote.model.
|
|
546
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
547
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
478
548
|
*/
|
|
479
|
-
|
|
549
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
550
|
+
realm?: string;
|
|
551
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
480
552
|
}
|
|
481
|
-
export declare class
|
|
553
|
+
export declare class ProvisioningResourceClient<O> {
|
|
482
554
|
protected httpClient: HttpClient<O>;
|
|
483
555
|
constructor(httpClient: HttpClient<O>);
|
|
484
556
|
/**
|
|
485
|
-
* HTTP
|
|
486
|
-
* Java method: org.openremote.model.
|
|
487
|
-
*/
|
|
488
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
489
|
-
/**
|
|
490
|
-
* HTTP POST /user/query
|
|
491
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
492
|
-
*/
|
|
493
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
494
|
-
/**
|
|
495
|
-
* HTTP GET /user/user
|
|
496
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
497
|
-
*/
|
|
498
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
499
|
-
/**
|
|
500
|
-
* HTTP GET /user/userRealmRoles
|
|
501
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
502
|
-
*/
|
|
503
|
-
getCurrentUserRealmRoles(options?: O): RestResponse<Model.Role[]>;
|
|
504
|
-
/**
|
|
505
|
-
* HTTP GET /user/userRoles
|
|
506
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRoles
|
|
507
|
-
*/
|
|
508
|
-
getCurrentUserRoles(options?: O): RestResponse<Model.Role[]>;
|
|
509
|
-
/**
|
|
510
|
-
* HTTP GET /user/userRoles/{clientId}
|
|
511
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
512
|
-
*/
|
|
513
|
-
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
514
|
-
/**
|
|
515
|
-
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
516
|
-
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
517
|
-
*/
|
|
518
|
-
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
519
|
-
/**
|
|
520
|
-
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
521
|
-
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
522
|
-
*/
|
|
523
|
-
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
524
|
-
/**
|
|
525
|
-
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
526
|
-
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
527
|
-
*/
|
|
528
|
-
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
529
|
-
/**
|
|
530
|
-
* HTTP GET /user/{realm}/roles
|
|
531
|
-
* Java method: org.openremote.model.security.UserResource.getRoles
|
|
532
|
-
*/
|
|
533
|
-
getRoles(realm: string, options?: O): RestResponse<Model.Role[]>;
|
|
534
|
-
/**
|
|
535
|
-
* HTTP PUT /user/{realm}/roles
|
|
536
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
537
|
-
*/
|
|
538
|
-
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
539
|
-
/**
|
|
540
|
-
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
541
|
-
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
542
|
-
*/
|
|
543
|
-
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
544
|
-
/**
|
|
545
|
-
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
546
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
547
|
-
*/
|
|
548
|
-
updateUserRealmRoles(realm: string, userId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
549
|
-
/**
|
|
550
|
-
* HTTP GET /user/{realm}/userRoles/{userId}
|
|
551
|
-
* Java method: org.openremote.model.security.UserResource.getUserRoles
|
|
552
|
-
*/
|
|
553
|
-
getUserRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
554
|
-
/**
|
|
555
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}
|
|
556
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRoles
|
|
557
|
+
* HTTP POST /provisioning
|
|
558
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
557
559
|
*/
|
|
558
|
-
|
|
560
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
559
561
|
/**
|
|
560
|
-
* HTTP GET /
|
|
561
|
-
* Java method: org.openremote.model.
|
|
562
|
+
* HTTP GET /provisioning
|
|
563
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
562
564
|
*/
|
|
563
|
-
|
|
565
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
564
566
|
/**
|
|
565
|
-
* HTTP
|
|
566
|
-
* Java method: org.openremote.model.
|
|
567
|
+
* HTTP DELETE /provisioning/{id}
|
|
568
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
567
569
|
*/
|
|
568
|
-
|
|
570
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
569
571
|
/**
|
|
570
|
-
* HTTP
|
|
571
|
-
* Java method: org.openremote.model.
|
|
572
|
+
* HTTP PUT /provisioning/{id}
|
|
573
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
572
574
|
*/
|
|
573
|
-
|
|
575
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
576
|
+
}
|
|
577
|
+
export declare class NotificationResourceClient<O> {
|
|
578
|
+
protected httpClient: HttpClient<O>;
|
|
579
|
+
constructor(httpClient: HttpClient<O>);
|
|
574
580
|
/**
|
|
575
|
-
* HTTP
|
|
576
|
-
* Java method: org.openremote.model.
|
|
581
|
+
* HTTP GET /notification
|
|
582
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
577
583
|
*/
|
|
578
|
-
|
|
584
|
+
getNotifications(queryParams?: {
|
|
585
|
+
id?: number;
|
|
586
|
+
type?: string;
|
|
587
|
+
from?: number;
|
|
588
|
+
to?: number;
|
|
589
|
+
realmId?: string;
|
|
590
|
+
userId?: string;
|
|
591
|
+
assetId?: string;
|
|
592
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
579
593
|
/**
|
|
580
|
-
* HTTP
|
|
581
|
-
* Java method: org.openremote.model.
|
|
594
|
+
* HTTP DELETE /notification
|
|
595
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
582
596
|
*/
|
|
583
|
-
|
|
597
|
+
removeNotifications(queryParams?: {
|
|
598
|
+
id?: number;
|
|
599
|
+
type?: string;
|
|
600
|
+
from?: number;
|
|
601
|
+
to?: number;
|
|
602
|
+
realmId?: string;
|
|
603
|
+
userId?: string;
|
|
604
|
+
assetId?: string;
|
|
605
|
+
}, options?: O): RestResponse<void>;
|
|
584
606
|
/**
|
|
585
|
-
* HTTP
|
|
586
|
-
* Java method: org.openremote.model.
|
|
607
|
+
* HTTP POST /notification/alert
|
|
608
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
587
609
|
*/
|
|
588
|
-
|
|
610
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
589
611
|
/**
|
|
590
|
-
* HTTP
|
|
591
|
-
* Java method: org.openremote.model.
|
|
612
|
+
* HTTP DELETE /notification/{notificationId}
|
|
613
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
592
614
|
*/
|
|
593
|
-
|
|
615
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
594
616
|
/**
|
|
595
|
-
* HTTP PUT /
|
|
596
|
-
* Java method: org.openremote.model.
|
|
617
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
618
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
597
619
|
*/
|
|
598
|
-
|
|
620
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
621
|
+
targetId?: string;
|
|
622
|
+
}, options?: O): RestResponse<void>;
|
|
599
623
|
/**
|
|
600
|
-
* HTTP
|
|
601
|
-
* Java method: org.openremote.model.
|
|
624
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
625
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
602
626
|
*/
|
|
603
|
-
|
|
627
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
628
|
+
targetId?: string;
|
|
629
|
+
}, options?: O): RestResponse<void>;
|
|
604
630
|
}
|
|
605
|
-
export declare class
|
|
631
|
+
export declare class ConsoleResourceClient<O> {
|
|
606
632
|
protected httpClient: HttpClient<O>;
|
|
607
633
|
constructor(httpClient: HttpClient<O>);
|
|
608
634
|
/**
|
|
609
|
-
* HTTP POST /
|
|
610
|
-
* Java method: org.openremote.model.
|
|
611
|
-
*/
|
|
612
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
613
|
-
/**
|
|
614
|
-
* HTTP GET /realm
|
|
615
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
616
|
-
*/
|
|
617
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
618
|
-
/**
|
|
619
|
-
* HTTP GET /realm/accessible
|
|
620
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
621
|
-
*/
|
|
622
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
623
|
-
/**
|
|
624
|
-
* HTTP DELETE /realm/{name}
|
|
625
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
626
|
-
*/
|
|
627
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
628
|
-
/**
|
|
629
|
-
* HTTP GET /realm/{name}
|
|
630
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
631
|
-
*/
|
|
632
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
633
|
-
/**
|
|
634
|
-
* HTTP PUT /realm/{name}
|
|
635
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
635
|
+
* HTTP POST /console/register
|
|
636
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
636
637
|
*/
|
|
637
|
-
|
|
638
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
638
639
|
}
|
|
639
|
-
export declare class
|
|
640
|
+
export declare class AppResourceClient<O> {
|
|
640
641
|
protected httpClient: HttpClient<O>;
|
|
641
642
|
constructor(httpClient: HttpClient<O>);
|
|
642
643
|
/**
|
|
643
|
-
* HTTP GET /
|
|
644
|
-
* Java method: org.openremote.model.
|
|
644
|
+
* HTTP GET /apps
|
|
645
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
645
646
|
*/
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
userId?: string;
|
|
653
|
-
assetId?: string;
|
|
654
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
647
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
648
|
+
/**
|
|
649
|
+
* HTTP GET /apps/consoleConfig
|
|
650
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
651
|
+
*/
|
|
652
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
655
653
|
/**
|
|
656
|
-
* HTTP
|
|
657
|
-
* Java method: org.openremote.model.
|
|
654
|
+
* HTTP GET /apps/info
|
|
655
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
658
656
|
*/
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
realmId?: string;
|
|
665
|
-
userId?: string;
|
|
666
|
-
assetId?: string;
|
|
667
|
-
}, options?: O): RestResponse<void>;
|
|
657
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
658
|
+
}
|
|
659
|
+
export declare class SyslogResourceClient<O> {
|
|
660
|
+
protected httpClient: HttpClient<O>;
|
|
661
|
+
constructor(httpClient: HttpClient<O>);
|
|
668
662
|
/**
|
|
669
|
-
* HTTP
|
|
670
|
-
* Java method: org.openremote.model.
|
|
663
|
+
* HTTP GET /syslog/config
|
|
664
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
671
665
|
*/
|
|
672
|
-
|
|
666
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
673
667
|
/**
|
|
674
|
-
* HTTP
|
|
675
|
-
* Java method: org.openremote.model.
|
|
668
|
+
* HTTP PUT /syslog/config
|
|
669
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
676
670
|
*/
|
|
677
|
-
|
|
671
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
678
672
|
/**
|
|
679
|
-
* HTTP
|
|
680
|
-
* Java method: org.openremote.model.
|
|
673
|
+
* HTTP DELETE /syslog/event
|
|
674
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
681
675
|
*/
|
|
682
|
-
|
|
683
|
-
targetId?: string;
|
|
684
|
-
}, options?: O): RestResponse<void>;
|
|
676
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
685
677
|
/**
|
|
686
|
-
* HTTP
|
|
687
|
-
* Java method: org.openremote.model.
|
|
678
|
+
* HTTP GET /syslog/event
|
|
679
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
688
680
|
*/
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
681
|
+
getEvents(queryParams?: {
|
|
682
|
+
level?: Model.SyslogLevel;
|
|
683
|
+
per_page?: number;
|
|
684
|
+
page?: number;
|
|
685
|
+
from?: number;
|
|
686
|
+
to?: number;
|
|
687
|
+
category?: Model.SyslogCategory[];
|
|
688
|
+
subCategory?: string[];
|
|
689
|
+
}, options?: O): RestResponse<any>;
|
|
692
690
|
}
|
|
693
691
|
export declare class MapResourceClient<O> {
|
|
694
692
|
protected httpClient: HttpClient<O>;
|
|
@@ -749,14 +747,24 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
749
747
|
*/
|
|
750
748
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
751
749
|
}
|
|
752
|
-
export declare class
|
|
750
|
+
export declare class FlowResourceClient<O> {
|
|
753
751
|
protected httpClient: HttpClient<O>;
|
|
754
752
|
constructor(httpClient: HttpClient<O>);
|
|
755
753
|
/**
|
|
756
|
-
* HTTP
|
|
757
|
-
* Java method: org.openremote.model.
|
|
754
|
+
* HTTP GET /flow
|
|
755
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
758
756
|
*/
|
|
759
|
-
|
|
757
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
758
|
+
/**
|
|
759
|
+
* HTTP GET /flow/{name}
|
|
760
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
761
|
+
*/
|
|
762
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
763
|
+
/**
|
|
764
|
+
* HTTP GET /flow/{type}
|
|
765
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
766
|
+
*/
|
|
767
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
760
768
|
}
|
|
761
769
|
export declare class GatewayClientResourceClient<O> {
|
|
762
770
|
protected httpClient: HttpClient<O>;
|
|
@@ -794,59 +802,6 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
794
802
|
*/
|
|
795
803
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
796
804
|
}
|
|
797
|
-
export declare class AlarmResourceClient<O> {
|
|
798
|
-
protected httpClient: HttpClient<O>;
|
|
799
|
-
constructor(httpClient: HttpClient<O>);
|
|
800
|
-
/**
|
|
801
|
-
* HTTP POST /alarm
|
|
802
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
803
|
-
*/
|
|
804
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
805
|
-
assetIds?: string[];
|
|
806
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
807
|
-
/**
|
|
808
|
-
* HTTP GET /alarm
|
|
809
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
810
|
-
*/
|
|
811
|
-
getAlarms(queryParams?: {
|
|
812
|
-
realm?: string;
|
|
813
|
-
status?: Model.AlarmStatus;
|
|
814
|
-
assetId?: string;
|
|
815
|
-
assigneeId?: string;
|
|
816
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
817
|
-
/**
|
|
818
|
-
* HTTP DELETE /alarm
|
|
819
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
820
|
-
*/
|
|
821
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
822
|
-
/**
|
|
823
|
-
* HTTP PUT /alarm/assets
|
|
824
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
825
|
-
*/
|
|
826
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
827
|
-
/**
|
|
828
|
-
* HTTP GET /alarm/{alarmId}
|
|
829
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
830
|
-
*/
|
|
831
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
832
|
-
/**
|
|
833
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
834
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
835
|
-
*/
|
|
836
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
837
|
-
/**
|
|
838
|
-
* HTTP PUT /alarm/{alarmId}
|
|
839
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
840
|
-
*/
|
|
841
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
842
|
-
/**
|
|
843
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
844
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
845
|
-
*/
|
|
846
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
847
|
-
realm?: string;
|
|
848
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
849
|
-
}
|
|
850
805
|
export declare class AssetDatapointResourceClient<O> {
|
|
851
806
|
protected httpClient: HttpClient<O>;
|
|
852
807
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -873,51 +828,96 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
873
828
|
*/
|
|
874
829
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
875
830
|
}
|
|
831
|
+
export declare class AssetModelResourceClient<O> {
|
|
832
|
+
protected httpClient: HttpClient<O>;
|
|
833
|
+
constructor(httpClient: HttpClient<O>);
|
|
834
|
+
/**
|
|
835
|
+
* HTTP GET /model/assetDescriptors
|
|
836
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
837
|
+
*/
|
|
838
|
+
getAssetDescriptors(queryParams?: {
|
|
839
|
+
parentId?: string;
|
|
840
|
+
parentType?: string;
|
|
841
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
842
|
+
/**
|
|
843
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
844
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
845
|
+
*/
|
|
846
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
847
|
+
parentId?: string;
|
|
848
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
849
|
+
/**
|
|
850
|
+
* HTTP GET /model/assetInfos
|
|
851
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
852
|
+
*/
|
|
853
|
+
getAssetInfos(queryParams?: {
|
|
854
|
+
parentId?: string;
|
|
855
|
+
parentType?: string;
|
|
856
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
857
|
+
/**
|
|
858
|
+
* HTTP GET /model/metaItemDescriptors
|
|
859
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
860
|
+
*/
|
|
861
|
+
getMetaItemDescriptors(queryParams?: {
|
|
862
|
+
parentId?: string;
|
|
863
|
+
}, options?: O): RestResponse<{
|
|
864
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
865
|
+
}>;
|
|
866
|
+
/**
|
|
867
|
+
* HTTP GET /model/valueDescriptors
|
|
868
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
869
|
+
*/
|
|
870
|
+
getValueDescriptors(queryParams?: {
|
|
871
|
+
parentId?: string;
|
|
872
|
+
}, options?: O): RestResponse<{
|
|
873
|
+
[index: string]: Model.ValueDescriptor;
|
|
874
|
+
}>;
|
|
875
|
+
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
879
|
-
protected
|
|
878
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
879
|
+
protected _userResource: AxiosUserResourceClient;
|
|
880
880
|
protected _agentResource: AxiosAgentResourceClient;
|
|
881
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
882
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
883
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
884
881
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
882
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
885
883
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
886
|
-
protected
|
|
887
|
-
protected _appResource: AxiosAppResourceClient;
|
|
888
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
889
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
890
|
-
protected _userResource: AxiosUserResourceClient;
|
|
884
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
891
885
|
protected _realmResource: AxiosRealmResourceClient;
|
|
886
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
887
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
888
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
892
889
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
890
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
891
|
+
protected _appResource: AxiosAppResourceClient;
|
|
892
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
893
893
|
protected _mapResource: AxiosMapResourceClient;
|
|
894
894
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
895
|
-
protected
|
|
895
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
896
896
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
897
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
898
897
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
898
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
901
|
-
get
|
|
900
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
901
|
+
get UserResource(): AxiosUserResourceClient;
|
|
902
902
|
get AgentResource(): AxiosAgentResourceClient;
|
|
903
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
904
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
905
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
906
903
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
904
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
907
905
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
908
|
-
get
|
|
909
|
-
get AppResource(): AxiosAppResourceClient;
|
|
910
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
911
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
912
|
-
get UserResource(): AxiosUserResourceClient;
|
|
906
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
913
907
|
get RealmResource(): AxiosRealmResourceClient;
|
|
908
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
909
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
910
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
914
911
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
912
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
913
|
+
get AppResource(): AxiosAppResourceClient;
|
|
914
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
915
915
|
get MapResource(): AxiosMapResourceClient;
|
|
916
916
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
917
|
-
get
|
|
917
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
918
918
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
919
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
920
919
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
920
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,49 +925,49 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
934
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
973
|
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -976,15 +976,15 @@ export declare class AxiosMapResourceClient extends MapResourceClient<Axios.Axio
|
|
|
976
976
|
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
982
|
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|