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