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