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