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