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