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