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