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