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