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