@openremote/rest 1.31.0-snapshot.20260924080557 → 1.31.0
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.
|
@@ -9,674 +9,622 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class RealmResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
17
|
-
* HTTP
|
|
18
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
17
|
+
* HTTP POST /realm
|
|
18
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
19
19
|
*/
|
|
20
|
-
|
|
20
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
23
|
-
* HTTP GET /
|
|
24
|
-
* Java method: org.openremote.model.
|
|
22
|
+
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
23
|
+
* HTTP GET /realm
|
|
24
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
25
25
|
*/
|
|
26
|
-
|
|
26
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
29
|
-
* HTTP GET /
|
|
30
|
-
* Java method: org.openremote.model.
|
|
28
|
+
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
29
|
+
* HTTP GET /realm/accessible
|
|
30
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
31
31
|
*/
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
32
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
33
|
+
/**
|
|
34
|
+
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
35
|
+
* Response code 405 - The master realm cannot be deleted
|
|
36
|
+
* HTTP DELETE /realm/{name}
|
|
37
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
38
|
+
*/
|
|
39
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
40
|
+
/**
|
|
41
|
+
* Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
|
|
42
|
+
* HTTP GET /realm/{name}
|
|
43
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
44
|
+
*/
|
|
45
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
46
|
+
/**
|
|
47
|
+
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
48
|
+
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
49
|
+
* HTTP PUT /realm/{name}
|
|
50
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
51
|
+
*/
|
|
52
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
35
53
|
}
|
|
36
|
-
export declare class
|
|
54
|
+
export declare class DashboardResourceClient<O> {
|
|
37
55
|
protected httpClient: HttpClient<O>;
|
|
38
56
|
constructor(httpClient: HttpClient<O>);
|
|
39
57
|
/**
|
|
40
|
-
*
|
|
41
|
-
* HTTP
|
|
42
|
-
* Java method: org.openremote.model.
|
|
58
|
+
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
59
|
+
* HTTP POST /dashboard
|
|
60
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
43
61
|
*/
|
|
44
|
-
|
|
45
|
-
realm?: string[];
|
|
46
|
-
}, options?: O): RestResponse<void>;
|
|
62
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
47
63
|
/**
|
|
48
|
-
*
|
|
49
|
-
* HTTP
|
|
50
|
-
* Java method: org.openremote.model.
|
|
64
|
+
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
65
|
+
* HTTP PUT /dashboard
|
|
66
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
51
67
|
*/
|
|
52
|
-
|
|
68
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
53
69
|
/**
|
|
54
|
-
*
|
|
55
|
-
* HTTP
|
|
56
|
-
* Java method: org.openremote.model.
|
|
70
|
+
* Returns dashboards visible to the caller in the requested realm. Anonymous callers receive public dashboards only; authenticated access also depends on roles, ownership, and linked assets.
|
|
71
|
+
* HTTP GET /dashboard/all/{realm}
|
|
72
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
57
73
|
*/
|
|
58
|
-
|
|
74
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
59
75
|
/**
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
76
|
+
* Executes a dashboard query after constraining it to the caller's realm, roles, ownership, and asset access. A missing body uses the request realm and default visibility rules.
|
|
77
|
+
* HTTP POST /dashboard/query
|
|
78
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
64
79
|
*/
|
|
65
|
-
|
|
80
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
66
81
|
/**
|
|
67
|
-
*
|
|
68
|
-
* HTTP
|
|
69
|
-
* Java method: org.openremote.model.
|
|
82
|
+
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
83
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
84
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
70
85
|
*/
|
|
71
|
-
|
|
86
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
72
87
|
/**
|
|
73
|
-
* Returns
|
|
74
|
-
* HTTP GET /
|
|
75
|
-
* Java method: org.openremote.model.
|
|
88
|
+
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
89
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
90
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
76
91
|
*/
|
|
77
|
-
|
|
92
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
78
93
|
}
|
|
79
|
-
export declare class
|
|
94
|
+
export declare class AssetResourceClient<O> {
|
|
80
95
|
protected httpClient: HttpClient<O>;
|
|
81
96
|
constructor(httpClient: HttpClient<O>);
|
|
82
97
|
/**
|
|
83
|
-
*
|
|
84
|
-
* HTTP
|
|
85
|
-
* Java method: org.openremote.model.asset.
|
|
98
|
+
* Creates an asset in an accessible realm and returns the persisted representation. The server generates an ID when absent; supplied IDs must be globally unique and 22 characters long.
|
|
99
|
+
* HTTP POST /asset
|
|
100
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
86
101
|
*/
|
|
87
|
-
|
|
88
|
-
parentId?: string;
|
|
89
|
-
parentType?: string;
|
|
90
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
102
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
91
103
|
/**
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
104
|
+
* Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
|
|
105
|
+
* HTTP DELETE /asset
|
|
106
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
96
107
|
*/
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
}, options?: O): RestResponse<
|
|
108
|
+
delete(queryParams?: {
|
|
109
|
+
assetId?: string[];
|
|
110
|
+
}, options?: O): RestResponse<void>;
|
|
100
111
|
/**
|
|
101
|
-
*
|
|
102
|
-
* HTTP
|
|
103
|
-
* Java method: org.openremote.model.asset.
|
|
112
|
+
* Submits a batch of attribute states using current server time and returns one result per input item. Authorization and processing failures are encoded in each AttributeWriteResult rather than returned as an HTTP error.
|
|
113
|
+
* HTTP PUT /asset/attributes
|
|
114
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
104
115
|
*/
|
|
105
|
-
|
|
106
|
-
parentId?: string;
|
|
107
|
-
parentType?: string;
|
|
108
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
116
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
109
117
|
/**
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
* HTTP GET /model/getValueDescriptorSchema
|
|
114
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
118
|
+
* Submits a batch of complete attribute events and returns one result per input item. Supplied timestamps are preserved; authorization and processing failures are encoded per result rather than returned as an HTTP error.
|
|
119
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
120
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
115
121
|
*/
|
|
116
|
-
|
|
117
|
-
name?: string;
|
|
118
|
-
}, options?: O): RestResponse<any>;
|
|
122
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
119
123
|
/**
|
|
120
|
-
* Returns
|
|
121
|
-
* HTTP
|
|
122
|
-
* Java method: org.openremote.model.asset.
|
|
124
|
+
* Returns only the number of assets matching an AssetQuery after applying the caller's realm, public, and linked-asset access constraints.
|
|
125
|
+
* HTTP POST /asset/count
|
|
126
|
+
* Java method: org.openremote.model.asset.AssetResource.queryCount
|
|
123
127
|
*/
|
|
124
|
-
|
|
125
|
-
parentId?: string;
|
|
126
|
-
}, options?: O): RestResponse<{
|
|
127
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
128
|
-
}>;
|
|
128
|
+
queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
|
|
129
129
|
/**
|
|
130
|
-
*
|
|
131
|
-
* HTTP
|
|
132
|
-
* Java method: org.openremote.model.asset.
|
|
130
|
+
* Clears the parent reference of every asset listed in repeated assetIds query parameters.
|
|
131
|
+
* HTTP DELETE /asset/parent
|
|
132
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
133
133
|
*/
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
}, options?: O): RestResponse<
|
|
137
|
-
[index: string]: Model.ValueDescriptor;
|
|
138
|
-
}>;
|
|
139
|
-
}
|
|
140
|
-
export declare class AgentResourceClient<O> {
|
|
141
|
-
protected httpClient: HttpClient<O>;
|
|
142
|
-
constructor(httpClient: HttpClient<O>);
|
|
134
|
+
updateNoneParent(queryParams?: {
|
|
135
|
+
assetIds?: string[];
|
|
136
|
+
}, options?: O): RestResponse<void>;
|
|
143
137
|
/**
|
|
144
|
-
*
|
|
145
|
-
* HTTP GET /
|
|
146
|
-
* Java method: org.openremote.model.asset.
|
|
138
|
+
* Returns the asset identity and properties without loading attributes or path data. The same access rules as getAsset apply.
|
|
139
|
+
* HTTP GET /asset/partial/{assetId}
|
|
140
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
147
141
|
*/
|
|
148
|
-
|
|
149
|
-
realm?: string;
|
|
150
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
142
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
151
143
|
/**
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
144
|
+
* Executes an AssetQuery after constraining realm and linked-asset access. Anonymous callers receive public-readable assets only; the query select clause controls which fields are populated.
|
|
145
|
+
* HTTP POST /asset/query
|
|
146
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
156
147
|
*/
|
|
157
|
-
|
|
158
|
-
realm?: string;
|
|
159
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
148
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
160
149
|
/**
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
150
|
+
* Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
|
|
151
|
+
* HTTP POST /asset/tree
|
|
152
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
165
153
|
*/
|
|
166
|
-
|
|
167
|
-
parentId?: string;
|
|
168
|
-
realm?: string;
|
|
169
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
170
|
-
}
|
|
171
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
172
|
-
protected httpClient: HttpClient<O>;
|
|
173
|
-
constructor(httpClient: HttpClient<O>);
|
|
154
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
174
155
|
/**
|
|
175
|
-
*
|
|
176
|
-
* HTTP
|
|
177
|
-
* Java method: org.openremote.model.
|
|
156
|
+
* Returns partial linked assets for a restricted user, root assets for an unrestricted realm user, and an empty array for a super user. Attributes and paths are omitted; use getAsset for full details.
|
|
157
|
+
* HTTP GET /asset/user/current
|
|
158
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
178
159
|
*/
|
|
179
|
-
|
|
160
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
180
161
|
/**
|
|
181
|
-
*
|
|
182
|
-
* HTTP
|
|
183
|
-
* Java method: org.openremote.model.
|
|
162
|
+
* Creates all supplied links as one operation. Every item must identify the same realm and user, and every referenced realm, user, and asset must exist.
|
|
163
|
+
* HTTP POST /asset/user/link
|
|
164
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
184
165
|
*/
|
|
185
|
-
|
|
186
|
-
}
|
|
187
|
-
export declare class StatusResourceClient<O> {
|
|
188
|
-
protected httpClient: HttpClient<O>;
|
|
189
|
-
constructor(httpClient: HttpClient<O>);
|
|
166
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
190
167
|
/**
|
|
191
|
-
* Returns
|
|
192
|
-
* HTTP GET /
|
|
193
|
-
* Java method: org.openremote.model.
|
|
168
|
+
* Returns user-asset links in the required realm, optionally filtered by userId and assetId. Missing users or assets produce an empty result; restricted users cannot call this operation.
|
|
169
|
+
* HTTP GET /asset/user/link
|
|
170
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
194
171
|
*/
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
172
|
+
getUserAssetLinks(queryParams?: {
|
|
173
|
+
realm?: string;
|
|
174
|
+
userId?: string;
|
|
175
|
+
assetId?: string;
|
|
176
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
198
177
|
/**
|
|
199
|
-
*
|
|
200
|
-
* HTTP
|
|
201
|
-
* Java method: org.openremote.model.
|
|
202
|
-
*/
|
|
203
|
-
getInfo(options?: O): RestResponse<{
|
|
204
|
-
[index: string]: any;
|
|
205
|
-
}>;
|
|
206
|
-
}
|
|
207
|
-
export declare class ConsoleResourceClient<O> {
|
|
208
|
-
protected httpClient: HttpClient<O>;
|
|
209
|
-
constructor(httpClient: HttpClient<O>);
|
|
210
|
-
/**
|
|
211
|
-
* Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
|
|
212
|
-
* HTTP POST /console/register
|
|
213
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
214
|
-
*/
|
|
215
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
216
|
-
}
|
|
217
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
218
|
-
protected httpClient: HttpClient<O>;
|
|
219
|
-
constructor(httpClient: HttpClient<O>);
|
|
220
|
-
/**
|
|
221
|
-
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
222
|
-
* Response code 417 - The gateway could not establish the requested tunnel
|
|
223
|
-
* HTTP POST /gateway/tunnel
|
|
224
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
225
|
-
*/
|
|
226
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
227
|
-
/**
|
|
228
|
-
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
229
|
-
* HTTP DELETE /gateway/tunnel
|
|
230
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
231
|
-
*/
|
|
232
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
233
|
-
/**
|
|
234
|
-
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
235
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
236
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
237
|
-
*/
|
|
238
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
239
|
-
/**
|
|
240
|
-
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
241
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
242
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
243
|
-
*/
|
|
244
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
245
|
-
/**
|
|
246
|
-
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
247
|
-
* Response code 204 - No active tunnel matches the requested endpoint
|
|
248
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
249
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
250
|
-
*/
|
|
251
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
252
|
-
}
|
|
253
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
254
|
-
protected httpClient: HttpClient<O>;
|
|
255
|
-
constructor(httpClient: HttpClient<O>);
|
|
256
|
-
/**
|
|
257
|
-
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
258
|
-
* Response code 200 - List of registered external services
|
|
259
|
-
* HTTP GET /service
|
|
260
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
261
|
-
*/
|
|
262
|
-
getServices(queryParams?: {
|
|
263
|
-
realm?: string;
|
|
264
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
265
|
-
/**
|
|
266
|
-
* Registers a realm-scoped service instance for the request realm. The caller must be a service account; the returned object contains the assigned instance ID and initial lease state.
|
|
267
|
-
* Response code 200 - Service registered successfully
|
|
268
|
-
* Response code 400 - Invalid external service object
|
|
269
|
-
* Response code 409 - ExternalService instance already registered
|
|
270
|
-
* HTTP POST /service
|
|
271
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
272
|
-
*/
|
|
273
|
-
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
274
|
-
/**
|
|
275
|
-
* Returns active registrations marked as globally available across realms.
|
|
276
|
-
* Response code 200 - List of registered external services
|
|
277
|
-
* HTTP GET /service/global
|
|
278
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
178
|
+
* Removes all supplied links. Every item must identify the same realm and user.
|
|
179
|
+
* HTTP POST /asset/user/link/delete
|
|
180
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
279
181
|
*/
|
|
280
|
-
|
|
182
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
281
183
|
/**
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
* Response code 409 - ExternalService instance already registered
|
|
286
|
-
* HTTP POST /service/global
|
|
287
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
184
|
+
* Removes every asset link belonging to the user in the requested realm.
|
|
185
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
186
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
288
187
|
*/
|
|
289
|
-
|
|
188
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
290
189
|
/**
|
|
291
|
-
* Removes
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
295
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
190
|
+
* Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
|
|
191
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
192
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
296
193
|
*/
|
|
297
|
-
|
|
194
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
298
195
|
/**
|
|
299
|
-
* Returns
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
303
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
196
|
+
* Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
|
|
197
|
+
* HTTP GET /asset/{assetId}
|
|
198
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
304
199
|
*/
|
|
305
|
-
|
|
200
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
306
201
|
/**
|
|
307
|
-
*
|
|
308
|
-
*
|
|
309
|
-
*
|
|
310
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
311
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
202
|
+
* Replaces mutable asset data while preserving the path identifier. Realm, parent, restricted-user, and private-metadata rules are validated; disallowed restricted-user fields may be ignored.
|
|
203
|
+
* HTTP PUT /asset/{assetId}
|
|
204
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
312
205
|
*/
|
|
313
|
-
|
|
314
|
-
}
|
|
315
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
316
|
-
protected httpClient: HttpClient<O>;
|
|
317
|
-
constructor(httpClient: HttpClient<O>);
|
|
206
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
318
207
|
/**
|
|
319
|
-
*
|
|
320
|
-
* Response code
|
|
321
|
-
*
|
|
322
|
-
*
|
|
208
|
+
* Submits an asynchronous attribute write using the current server time. The result reports whether the event was accepted, not whether downstream processing ultimately succeeded. Anonymous writes require public-write metadata.
|
|
209
|
+
* Response code 400 - The attribute write failed
|
|
210
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
211
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
212
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
213
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
323
214
|
*/
|
|
324
|
-
|
|
325
|
-
attributeRefs?: string;
|
|
326
|
-
fromTimestamp?: number;
|
|
327
|
-
toTimestamp?: number;
|
|
328
|
-
format?: Model.DatapointExportFormat;
|
|
329
|
-
}, options?: O): RestResponse<any>;
|
|
215
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
330
216
|
/**
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
217
|
+
* Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
|
|
218
|
+
* Response code 400 - The attribute write failed
|
|
219
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
220
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
221
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
222
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
334
223
|
*/
|
|
335
|
-
|
|
336
|
-
assetId?: string;
|
|
337
|
-
attributeName?: string;
|
|
338
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
224
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
339
225
|
/**
|
|
340
|
-
*
|
|
341
|
-
* HTTP
|
|
342
|
-
* Java method: org.openremote.model.
|
|
226
|
+
* Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
|
|
227
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
228
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
343
229
|
*/
|
|
344
|
-
|
|
230
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
231
|
+
assetIds?: string[];
|
|
232
|
+
}, options?: O): RestResponse<void>;
|
|
345
233
|
}
|
|
346
|
-
export declare class
|
|
234
|
+
export declare class ConfigurationResourceClient<O> {
|
|
347
235
|
protected httpClient: HttpClient<O>;
|
|
348
236
|
constructor(httpClient: HttpClient<O>);
|
|
349
237
|
/**
|
|
350
|
-
*
|
|
351
|
-
* HTTP
|
|
352
|
-
* Java method: org.openremote.model.
|
|
238
|
+
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
239
|
+
* HTTP GET /configuration/manager
|
|
240
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
353
241
|
*/
|
|
354
|
-
|
|
242
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
355
243
|
/**
|
|
356
|
-
*
|
|
357
|
-
* HTTP
|
|
358
|
-
* Java method: org.openremote.model.
|
|
244
|
+
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
|
|
245
|
+
* HTTP PUT /configuration/manager
|
|
246
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
359
247
|
*/
|
|
360
|
-
|
|
248
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
361
249
|
/**
|
|
362
|
-
*
|
|
363
|
-
* HTTP
|
|
364
|
-
* Java method: org.openremote.model.
|
|
250
|
+
* Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
|
|
251
|
+
* HTTP POST /configuration/manager/file
|
|
252
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
365
253
|
*/
|
|
366
|
-
|
|
254
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
255
|
+
path?: string;
|
|
256
|
+
}, options?: O): RestResponse<string>;
|
|
367
257
|
/**
|
|
368
|
-
*
|
|
369
|
-
*
|
|
370
|
-
*
|
|
258
|
+
* Streams a previously uploaded configuration image using its detected media type.
|
|
259
|
+
* Response code 200 - The image file
|
|
260
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
261
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
371
262
|
*/
|
|
372
|
-
|
|
263
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
373
264
|
}
|
|
374
|
-
export declare class
|
|
265
|
+
export declare class NotificationResourceClient<O> {
|
|
375
266
|
protected httpClient: HttpClient<O>;
|
|
376
267
|
constructor(httpClient: HttpClient<O>);
|
|
377
268
|
/**
|
|
378
|
-
* Returns realm-
|
|
379
|
-
* HTTP GET /
|
|
380
|
-
* Java method: org.openremote.model.
|
|
381
|
-
*/
|
|
382
|
-
getSettings(options?: O): RestResponse<{
|
|
383
|
-
[id: string]: unknown;
|
|
384
|
-
}>;
|
|
385
|
-
/**
|
|
386
|
-
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
387
|
-
* HTTP PUT /map
|
|
388
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
389
|
-
*/
|
|
390
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
391
|
-
[id: string]: unknown;
|
|
392
|
-
}>;
|
|
393
|
-
/**
|
|
394
|
-
* Deletes the installed custom MBTiles database and returns the fallback public map settings.
|
|
395
|
-
* HTTP DELETE /map/deleteMap
|
|
396
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
397
|
-
*/
|
|
398
|
-
deleteMap(options?: O): RestResponse<{
|
|
399
|
-
[id: string]: unknown;
|
|
400
|
-
}>;
|
|
401
|
-
/**
|
|
402
|
-
* Reports whether custom MBTiles data is installed and the maximum accepted upload size.
|
|
403
|
-
* HTTP GET /map/getCustomMapInfo
|
|
404
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
405
|
-
*/
|
|
406
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
407
|
-
[id: string]: unknown;
|
|
408
|
-
}>;
|
|
409
|
-
/**
|
|
410
|
-
* Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
|
|
411
|
-
* Response code 200 - Gzip-compressed vector tile
|
|
412
|
-
* Response code 204 - No tile exists at the requested coordinates
|
|
413
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
414
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
415
|
-
*/
|
|
416
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
417
|
-
/**
|
|
418
|
-
* Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
|
|
419
|
-
* HTTP POST /map/upload
|
|
420
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
269
|
+
* Returns sent-notification records filtered by identity, message type, time, realm, target, source, sorting, and pagination. Results are realm-scoped and sensitive target/source identifiers are redacted when the caller lacks user or asset read permission.
|
|
270
|
+
* HTTP GET /notification
|
|
271
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
421
272
|
*/
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
273
|
+
getNotifications(queryParams?: {
|
|
274
|
+
id?: number;
|
|
275
|
+
type?: string;
|
|
276
|
+
from?: number;
|
|
277
|
+
to?: number;
|
|
278
|
+
realmId?: string;
|
|
279
|
+
userId?: string;
|
|
280
|
+
assetId?: string;
|
|
281
|
+
source?: Model.NotificationSource;
|
|
282
|
+
sort?: Model.SentNotificationSortField;
|
|
283
|
+
descending?: boolean;
|
|
284
|
+
offset?: number;
|
|
285
|
+
limit?: number;
|
|
286
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
431
287
|
/**
|
|
432
|
-
*
|
|
433
|
-
* HTTP
|
|
434
|
-
* Java method: org.openremote.model.
|
|
288
|
+
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
289
|
+
* HTTP DELETE /notification
|
|
290
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
435
291
|
*/
|
|
436
|
-
|
|
292
|
+
removeNotifications(queryParams?: {
|
|
293
|
+
id?: number;
|
|
294
|
+
type?: string;
|
|
295
|
+
from?: number;
|
|
296
|
+
to?: number;
|
|
297
|
+
realmId?: string;
|
|
298
|
+
userId?: string;
|
|
299
|
+
assetId?: string;
|
|
300
|
+
}, options?: O): RestResponse<void>;
|
|
437
301
|
/**
|
|
438
|
-
*
|
|
439
|
-
* HTTP
|
|
440
|
-
* Java method: org.openremote.model.
|
|
302
|
+
* Queues a notification for delivery. Authorization is checked for every target; if any target is inaccessible, the complete request fails rather than sending a partial set.
|
|
303
|
+
* HTTP POST /notification/alert
|
|
304
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
441
305
|
*/
|
|
442
|
-
|
|
306
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
443
307
|
/**
|
|
444
|
-
* Returns
|
|
445
|
-
* HTTP GET /
|
|
446
|
-
* Java method: org.openremote.model.
|
|
308
|
+
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
309
|
+
* HTTP GET /notification/count
|
|
310
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
447
311
|
*/
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
312
|
+
getNotificationsCount(queryParams?: {
|
|
313
|
+
type?: string;
|
|
314
|
+
from?: number;
|
|
315
|
+
to?: number;
|
|
316
|
+
realmId?: string;
|
|
317
|
+
userId?: string;
|
|
318
|
+
assetId?: string;
|
|
319
|
+
source?: Model.NotificationSource;
|
|
320
|
+
}, options?: O): RestResponse<number>;
|
|
321
|
+
/**
|
|
322
|
+
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
323
|
+
* HTTP DELETE /notification/{notificationId}
|
|
324
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
454
325
|
*/
|
|
455
|
-
|
|
326
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
456
327
|
/**
|
|
457
|
-
*
|
|
458
|
-
* HTTP
|
|
459
|
-
* Java method: org.openremote.model.
|
|
328
|
+
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
329
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
330
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
460
331
|
*/
|
|
461
|
-
|
|
332
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
333
|
+
targetId?: string;
|
|
334
|
+
}, options?: O): RestResponse<void>;
|
|
462
335
|
/**
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
336
|
+
* Marks one target's notification as delivered after matching both notificationId and targetId. Anonymous callers may update notifications sent to a public asset; authenticated callers are constrained to their own user, realm, or accessible assets.
|
|
337
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
338
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
467
339
|
*/
|
|
468
|
-
|
|
340
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
341
|
+
targetId?: string;
|
|
342
|
+
}, options?: O): RestResponse<void>;
|
|
469
343
|
}
|
|
470
|
-
export declare class
|
|
344
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
471
345
|
protected httpClient: HttpClient<O>;
|
|
472
346
|
constructor(httpClient: HttpClient<O>);
|
|
473
347
|
/**
|
|
474
|
-
* Returns
|
|
475
|
-
*
|
|
476
|
-
*
|
|
348
|
+
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
349
|
+
* Response code 200 - List of registered external services
|
|
350
|
+
* HTTP GET /service
|
|
351
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
477
352
|
*/
|
|
478
|
-
|
|
353
|
+
getServices(queryParams?: {
|
|
354
|
+
realm?: string;
|
|
355
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
479
356
|
/**
|
|
480
|
-
*
|
|
481
|
-
*
|
|
482
|
-
*
|
|
357
|
+
* Registers a realm-scoped service instance for the request realm. The caller must be a service account; the returned object contains the assigned instance ID and initial lease state.
|
|
358
|
+
* Response code 200 - Service registered successfully
|
|
359
|
+
* Response code 400 - Invalid external service object
|
|
360
|
+
* Response code 409 - ExternalService instance already registered
|
|
361
|
+
* HTTP POST /service
|
|
362
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
483
363
|
*/
|
|
484
|
-
|
|
364
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
485
365
|
/**
|
|
486
|
-
* Returns
|
|
487
|
-
*
|
|
488
|
-
*
|
|
366
|
+
* Returns active registrations marked as globally available across realms.
|
|
367
|
+
* Response code 200 - List of registered external services
|
|
368
|
+
* HTTP GET /service/global
|
|
369
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
489
370
|
*/
|
|
490
|
-
|
|
491
|
-
}
|
|
492
|
-
export declare class SyslogResourceClient<O> {
|
|
493
|
-
protected httpClient: HttpClient<O>;
|
|
494
|
-
constructor(httpClient: HttpClient<O>);
|
|
371
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
495
372
|
/**
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
373
|
+
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
374
|
+
* Response code 200 - Service registered successfully
|
|
375
|
+
* Response code 400 - Invalid external service object
|
|
376
|
+
* Response code 409 - ExternalService instance already registered
|
|
377
|
+
* HTTP POST /service/global
|
|
378
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
499
379
|
*/
|
|
500
|
-
|
|
380
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
501
381
|
/**
|
|
502
|
-
*
|
|
503
|
-
*
|
|
504
|
-
*
|
|
382
|
+
* Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
|
|
383
|
+
* Response code 204 - Service deregistered successfully
|
|
384
|
+
* Response code 404 - Service instance not found
|
|
385
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
386
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
505
387
|
*/
|
|
506
|
-
|
|
388
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
507
389
|
/**
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
390
|
+
* Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
|
|
391
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
392
|
+
* Response code 404 - ExternalService not found
|
|
393
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
394
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
511
395
|
*/
|
|
512
|
-
|
|
396
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
513
397
|
/**
|
|
514
|
-
*
|
|
515
|
-
* Response code
|
|
516
|
-
*
|
|
517
|
-
*
|
|
398
|
+
* Extends the lease of one service instance. The caller must be the service account that registered it; global-service heartbeats additionally require a super user.
|
|
399
|
+
* Response code 204 - Heartbeat sent successfully
|
|
400
|
+
* Response code 404 - Service instance not found
|
|
401
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
402
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
518
403
|
*/
|
|
519
|
-
|
|
520
|
-
level?: Model.SyslogLevel;
|
|
521
|
-
per_page?: number;
|
|
522
|
-
page?: number;
|
|
523
|
-
from?: number;
|
|
524
|
-
to?: number;
|
|
525
|
-
category?: Model.SyslogCategory[];
|
|
526
|
-
subCategory?: string[];
|
|
527
|
-
}, options?: O): RestResponse<any>;
|
|
404
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
528
405
|
}
|
|
529
|
-
export declare class
|
|
406
|
+
export declare class AgentResourceClient<O> {
|
|
530
407
|
protected httpClient: HttpClient<O>;
|
|
531
408
|
constructor(httpClient: HttpClient<O>);
|
|
532
409
|
/**
|
|
533
|
-
*
|
|
534
|
-
* HTTP
|
|
535
|
-
* Java method: org.openremote.model.
|
|
410
|
+
* Runs the agent protocol's asset discovery, waits up to ten seconds for results, returns the discovered tree, and asynchronously persists discovered assets below the agent.
|
|
411
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
412
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
536
413
|
*/
|
|
537
|
-
|
|
414
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
415
|
+
realm?: string;
|
|
416
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
538
417
|
/**
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
418
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
419
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
420
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
421
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
542
422
|
*/
|
|
543
|
-
|
|
423
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
424
|
+
realm?: string;
|
|
425
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
544
426
|
/**
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
427
|
+
* Runs instance discovery for an agent type and returns candidate Agent assets. parentId selects local versus edge-gateway discovery; non-super users are always constrained to their authenticated realm.
|
|
428
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
429
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
430
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
548
431
|
*/
|
|
549
|
-
|
|
432
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
433
|
+
parentId?: string;
|
|
434
|
+
realm?: string;
|
|
435
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
436
|
+
}
|
|
437
|
+
export declare class ConsoleResourceClient<O> {
|
|
438
|
+
protected httpClient: HttpClient<O>;
|
|
439
|
+
constructor(httpClient: HttpClient<O>);
|
|
550
440
|
/**
|
|
551
|
-
*
|
|
552
|
-
* HTTP
|
|
553
|
-
* Java method: org.openremote.model.
|
|
441
|
+
* Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
|
|
442
|
+
* HTTP POST /console/register
|
|
443
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
554
444
|
*/
|
|
555
|
-
|
|
445
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
446
|
+
}
|
|
447
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
448
|
+
protected httpClient: HttpClient<O>;
|
|
449
|
+
constructor(httpClient: HttpClient<O>);
|
|
556
450
|
/**
|
|
557
|
-
*
|
|
558
|
-
* HTTP
|
|
559
|
-
* Java method: org.openremote.model.
|
|
451
|
+
* Queries predicted values for one attribute using the supplied time-range and aggregation criteria. Anonymous access requires public-read access on both asset and attribute.
|
|
452
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
453
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
560
454
|
*/
|
|
561
|
-
|
|
455
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
562
456
|
/**
|
|
563
|
-
*
|
|
564
|
-
* HTTP
|
|
565
|
-
* Java method: org.openremote.model.
|
|
457
|
+
* Replaces or adds predicted values for one attribute. Anonymous access is allowed only when the asset and attribute are public-write; authenticated callers require attribute-write access.
|
|
458
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
459
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
566
460
|
*/
|
|
567
|
-
|
|
461
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
462
|
+
}
|
|
463
|
+
export declare class AlarmResourceClient<O> {
|
|
464
|
+
protected httpClient: HttpClient<O>;
|
|
465
|
+
constructor(httpClient: HttpClient<O>);
|
|
568
466
|
/**
|
|
569
|
-
*
|
|
570
|
-
* HTTP
|
|
571
|
-
* Java method: org.openremote.model.
|
|
467
|
+
* Creates a manual alarm in an accessible realm and optionally links it to the supplied asset IDs. The authenticated user or client becomes the alarm source.
|
|
468
|
+
* HTTP POST /alarm
|
|
469
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
572
470
|
*/
|
|
573
|
-
|
|
471
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
472
|
+
assetIds?: string[];
|
|
473
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
574
474
|
/**
|
|
575
|
-
* Returns
|
|
576
|
-
* HTTP GET /
|
|
577
|
-
* Java method: org.openremote.model.
|
|
475
|
+
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
476
|
+
* HTTP GET /alarm
|
|
477
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
578
478
|
*/
|
|
579
|
-
|
|
479
|
+
getAlarms(queryParams?: {
|
|
480
|
+
realm?: string;
|
|
481
|
+
status?: Model.AlarmStatus;
|
|
482
|
+
assetId?: string;
|
|
483
|
+
assigneeId?: string;
|
|
484
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
580
485
|
/**
|
|
581
|
-
*
|
|
582
|
-
* HTTP
|
|
583
|
-
* Java method: org.openremote.model.
|
|
486
|
+
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
487
|
+
* HTTP DELETE /alarm
|
|
488
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
584
489
|
*/
|
|
585
|
-
|
|
490
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
586
491
|
/**
|
|
587
|
-
*
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
492
|
+
* Adds links between assets and one existing alarm.
|
|
493
|
+
|
|
494
|
+
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
495
|
+
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
496
|
+
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
497
|
+
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
498
|
+
|
|
499
|
+
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
500
|
+
This operation does not remove existing links from the alarm.
|
|
501
|
+
|
|
502
|
+
* HTTP PUT /alarm/assets
|
|
503
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
591
504
|
*/
|
|
592
|
-
|
|
505
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
593
506
|
/**
|
|
594
|
-
*
|
|
595
|
-
*
|
|
596
|
-
*
|
|
597
|
-
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
507
|
+
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
508
|
+
* HTTP GET /alarm/{alarmId}
|
|
509
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
598
510
|
*/
|
|
599
|
-
|
|
511
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
600
512
|
/**
|
|
601
|
-
*
|
|
602
|
-
* HTTP
|
|
603
|
-
* Java method: org.openremote.model.
|
|
513
|
+
* Permanently removes one alarm after verifying access to its realm.
|
|
514
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
515
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
604
516
|
*/
|
|
605
|
-
|
|
517
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
606
518
|
/**
|
|
607
|
-
*
|
|
608
|
-
* HTTP PUT /
|
|
609
|
-
* Java method: org.openremote.model.
|
|
519
|
+
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
520
|
+
* HTTP PUT /alarm/{alarmId}
|
|
521
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
610
522
|
*/
|
|
611
|
-
|
|
523
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
524
|
+
/**
|
|
525
|
+
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
526
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
527
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
528
|
+
*/
|
|
529
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
530
|
+
realm?: string;
|
|
531
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
532
|
+
}
|
|
533
|
+
export declare class ProvisioningResourceClient<O> {
|
|
534
|
+
protected httpClient: HttpClient<O>;
|
|
535
|
+
constructor(httpClient: HttpClient<O>);
|
|
612
536
|
/**
|
|
613
|
-
*
|
|
614
|
-
* HTTP
|
|
615
|
-
* Java method: org.openremote.model.
|
|
537
|
+
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
538
|
+
* HTTP POST /provisioning
|
|
539
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
616
540
|
*/
|
|
617
|
-
|
|
541
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
618
542
|
/**
|
|
619
|
-
*
|
|
620
|
-
* HTTP
|
|
621
|
-
* Java method: org.openremote.model.
|
|
543
|
+
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
544
|
+
* HTTP GET /provisioning
|
|
545
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
622
546
|
*/
|
|
623
|
-
|
|
547
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
624
548
|
/**
|
|
625
|
-
*
|
|
626
|
-
* HTTP
|
|
627
|
-
* Java method: org.openremote.model.
|
|
549
|
+
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
550
|
+
* HTTP DELETE /provisioning/{id}
|
|
551
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
628
552
|
*/
|
|
629
|
-
|
|
553
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
630
554
|
/**
|
|
631
|
-
* Replaces the
|
|
632
|
-
* HTTP PUT /
|
|
633
|
-
* Java method: org.openremote.model.
|
|
555
|
+
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
556
|
+
* HTTP PUT /provisioning/{id}
|
|
557
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
634
558
|
*/
|
|
635
|
-
|
|
559
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
560
|
+
}
|
|
561
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
562
|
+
protected httpClient: HttpClient<O>;
|
|
563
|
+
constructor(httpClient: HttpClient<O>);
|
|
636
564
|
/**
|
|
637
|
-
*
|
|
638
|
-
*
|
|
639
|
-
*
|
|
565
|
+
* Streams a ZIP archive containing exported datapoints for one or more attribute references over the requested inclusive time range. attributeRefs is a JSON-encoded array of objects with id and name fields.
|
|
566
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
567
|
+
* HTTP GET /asset/datapoint/export
|
|
568
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
640
569
|
*/
|
|
641
|
-
|
|
570
|
+
getDatapointExport(queryParams?: {
|
|
571
|
+
attributeRefs?: string;
|
|
572
|
+
fromTimestamp?: number;
|
|
573
|
+
toTimestamp?: number;
|
|
574
|
+
format?: Model.DatapointExportFormat;
|
|
575
|
+
}, options?: O): RestResponse<any>;
|
|
642
576
|
/**
|
|
643
|
-
*
|
|
644
|
-
* HTTP
|
|
645
|
-
* Java method: org.openremote.model.
|
|
577
|
+
* Returns the oldest and newest stored timestamps for one attribute. The asset and attribute must be readable by the authenticated user and configured for datapoint storage.
|
|
578
|
+
* HTTP GET /asset/datapoint/periods
|
|
579
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
646
580
|
*/
|
|
647
|
-
|
|
581
|
+
getDatapointPeriod(queryParams?: {
|
|
582
|
+
assetId?: string;
|
|
583
|
+
attributeName?: string;
|
|
584
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
648
585
|
/**
|
|
649
|
-
*
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
586
|
+
* Returns stored historical values for one attribute. A null body returns the available series; a polymorphic query body controls the time range and retrieval or aggregation strategy. Anonymous access requires public-read access on both asset and attribute.
|
|
587
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
588
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
653
589
|
*/
|
|
654
|
-
|
|
590
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
591
|
+
}
|
|
592
|
+
export declare class SyslogResourceClient<O> {
|
|
593
|
+
protected httpClient: HttpClient<O>;
|
|
594
|
+
constructor(httpClient: HttpClient<O>);
|
|
655
595
|
/**
|
|
656
|
-
*
|
|
657
|
-
*
|
|
658
|
-
*
|
|
659
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
596
|
+
* Returns the current log-storage and retention configuration.
|
|
597
|
+
* HTTP GET /syslog/config
|
|
598
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
660
599
|
*/
|
|
661
|
-
|
|
600
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
662
601
|
/**
|
|
663
|
-
*
|
|
664
|
-
* HTTP
|
|
665
|
-
* Java method: org.openremote.model.
|
|
602
|
+
* Validates and applies log-storage and retention settings.
|
|
603
|
+
* HTTP PUT /syslog/config
|
|
604
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
666
605
|
*/
|
|
667
|
-
|
|
606
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
668
607
|
/**
|
|
669
|
-
*
|
|
670
|
-
* HTTP
|
|
671
|
-
* Java method: org.openremote.model.
|
|
608
|
+
* Permanently removes all events from the configured syslog storage.
|
|
609
|
+
* HTTP DELETE /syslog/event
|
|
610
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
672
611
|
*/
|
|
673
|
-
|
|
612
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
674
613
|
/**
|
|
675
|
-
* Returns
|
|
676
|
-
*
|
|
677
|
-
*
|
|
614
|
+
* Returns a page of log events filtered by severity, Unix-millisecond time range, categories, and subcategories. RFC 8288 Link headers point to the next and last pages.
|
|
615
|
+
* Response code 200 - The requested page of syslog events
|
|
616
|
+
* HTTP GET /syslog/event
|
|
617
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
678
618
|
*/
|
|
679
|
-
|
|
619
|
+
getEvents(queryParams?: {
|
|
620
|
+
level?: Model.SyslogLevel;
|
|
621
|
+
per_page?: number;
|
|
622
|
+
page?: number;
|
|
623
|
+
from?: number;
|
|
624
|
+
to?: number;
|
|
625
|
+
category?: Model.SyslogCategory[];
|
|
626
|
+
subCategory?: string[];
|
|
627
|
+
}, options?: O): RestResponse<any>;
|
|
680
628
|
}
|
|
681
629
|
export declare class RulesResourceClient<O> {
|
|
682
630
|
protected httpClient: HttpClient<O>;
|
|
@@ -808,413 +756,468 @@ export declare class RulesResourceClient<O> {
|
|
|
808
756
|
*/
|
|
809
757
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
810
758
|
}
|
|
811
|
-
export declare class
|
|
759
|
+
export declare class FlowResourceClient<O> {
|
|
812
760
|
protected httpClient: HttpClient<O>;
|
|
813
761
|
constructor(httpClient: HttpClient<O>);
|
|
814
762
|
/**
|
|
815
|
-
* Returns
|
|
816
|
-
* HTTP GET /
|
|
817
|
-
* Java method: org.openremote.model.
|
|
763
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
764
|
+
* HTTP GET /flow
|
|
765
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
818
766
|
*/
|
|
819
|
-
|
|
820
|
-
id?: number;
|
|
821
|
-
type?: string;
|
|
822
|
-
from?: number;
|
|
823
|
-
to?: number;
|
|
824
|
-
realmId?: string;
|
|
825
|
-
userId?: string;
|
|
826
|
-
assetId?: string;
|
|
827
|
-
source?: Model.NotificationSource;
|
|
828
|
-
sort?: Model.SentNotificationSortField;
|
|
829
|
-
descending?: boolean;
|
|
830
|
-
offset?: number;
|
|
831
|
-
limit?: number;
|
|
832
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
767
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
833
768
|
/**
|
|
834
|
-
*
|
|
835
|
-
* HTTP
|
|
836
|
-
* Java method: org.openremote.model.
|
|
769
|
+
* Resolves one flow node definition by its model name.
|
|
770
|
+
* HTTP GET /flow/{name}
|
|
771
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
837
772
|
*/
|
|
838
|
-
|
|
839
|
-
id?: number;
|
|
840
|
-
type?: string;
|
|
841
|
-
from?: number;
|
|
842
|
-
to?: number;
|
|
843
|
-
realmId?: string;
|
|
844
|
-
userId?: string;
|
|
845
|
-
assetId?: string;
|
|
846
|
-
}, options?: O): RestResponse<void>;
|
|
773
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
847
774
|
/**
|
|
848
|
-
*
|
|
849
|
-
* HTTP
|
|
850
|
-
* Java method: org.openremote.model.
|
|
775
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
776
|
+
* HTTP GET /flow/{type}
|
|
777
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
851
778
|
*/
|
|
852
|
-
|
|
779
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
780
|
+
}
|
|
781
|
+
export declare class MapResourceClient<O> {
|
|
782
|
+
protected httpClient: HttpClient<O>;
|
|
783
|
+
constructor(httpClient: HttpClient<O>);
|
|
853
784
|
/**
|
|
854
|
-
* Returns
|
|
855
|
-
* HTTP GET /
|
|
856
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
|
|
786
|
+
* HTTP GET /map
|
|
787
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
857
788
|
*/
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
789
|
+
getSettings(options?: O): RestResponse<{
|
|
790
|
+
[id: string]: unknown;
|
|
791
|
+
}>;
|
|
792
|
+
/**
|
|
793
|
+
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
794
|
+
* HTTP PUT /map
|
|
795
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
796
|
+
*/
|
|
797
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
798
|
+
[id: string]: unknown;
|
|
799
|
+
}>;
|
|
800
|
+
/**
|
|
801
|
+
* Deletes the installed custom MBTiles database and returns the fallback public map settings.
|
|
802
|
+
* HTTP DELETE /map/deleteMap
|
|
803
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
804
|
+
*/
|
|
805
|
+
deleteMap(options?: O): RestResponse<{
|
|
806
|
+
[id: string]: unknown;
|
|
807
|
+
}>;
|
|
808
|
+
/**
|
|
809
|
+
* Reports whether custom MBTiles data is installed and the maximum accepted upload size.
|
|
810
|
+
* HTTP GET /map/getCustomMapInfo
|
|
811
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
812
|
+
*/
|
|
813
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
814
|
+
[id: string]: unknown;
|
|
815
|
+
}>;
|
|
816
|
+
/**
|
|
817
|
+
* Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
|
|
818
|
+
* Response code 200 - Gzip-compressed vector tile
|
|
819
|
+
* Response code 204 - No tile exists at the requested coordinates
|
|
820
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
821
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
822
|
+
*/
|
|
823
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
824
|
+
/**
|
|
825
|
+
* Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
|
|
826
|
+
* HTTP POST /map/upload
|
|
827
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
828
|
+
*/
|
|
829
|
+
uploadMap(queryParams?: {
|
|
830
|
+
filename?: string;
|
|
831
|
+
}, options?: O): RestResponse<{
|
|
832
|
+
[id: string]: unknown;
|
|
833
|
+
}>;
|
|
834
|
+
}
|
|
835
|
+
export declare class UserResourceClient<O> {
|
|
836
|
+
protected httpClient: HttpClient<O>;
|
|
837
|
+
constructor(httpClient: HttpClient<O>);
|
|
838
|
+
/**
|
|
839
|
+
* Stores the supplied non-empty locale string as the caller's identity-provider locale attribute. The target realm must be active unless the caller is a superuser.
|
|
840
|
+
* HTTP PUT /user/locale
|
|
841
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
842
|
+
*/
|
|
843
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
844
|
+
/**
|
|
845
|
+
* Executes a UserQuery. Non-super users are forced into their authenticated realm and cannot see system accounts; callers with read-users but not read-admin receive basic fields only. The target realm must be active unless the caller is a superuser.
|
|
846
|
+
* HTTP POST /user/query
|
|
847
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
848
|
+
*/
|
|
849
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
850
|
+
/**
|
|
851
|
+
* Initiates the identity provider's configured password-reset action for the caller's own account. The target realm must be active unless the caller is a superuser.
|
|
852
|
+
* HTTP PUT /user/request-password-reset
|
|
853
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
854
|
+
*/
|
|
855
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
856
|
+
/**
|
|
857
|
+
* Replaces the caller's own identity-provider credential using the supplied credential representation. The target realm must be active unless the caller is a superuser.
|
|
858
|
+
* HTTP PUT /user/reset-password
|
|
859
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
860
|
+
*/
|
|
861
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
862
|
+
/**
|
|
863
|
+
* Updates the caller's own profile. A supplied user ID must match the access token; role and realm administration are not provided by this endpoint. The target realm must be active unless the caller is a superuser.
|
|
864
|
+
* HTTP PUT /user/update
|
|
865
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
866
|
+
*/
|
|
867
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
868
|
+
/**
|
|
869
|
+
* Returns the identity-provider record corresponding to the current access token. The target realm must be active unless the caller is a superuser.
|
|
870
|
+
* HTTP GET /user/user
|
|
871
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
872
|
+
*/
|
|
873
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
874
|
+
/**
|
|
875
|
+
* Returns realm-level role names assigned to the caller. The target realm must be active unless the caller is a superuser.
|
|
876
|
+
* HTTP GET /user/userRealmRoles
|
|
877
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
878
|
+
*/
|
|
879
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
867
880
|
/**
|
|
868
|
-
*
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
881
|
+
* Returns role names assigned to the caller for the named identity-provider client. The target realm must be active unless the caller is a superuser.
|
|
882
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
883
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
871
884
|
*/
|
|
872
|
-
|
|
885
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
873
886
|
/**
|
|
874
|
-
*
|
|
875
|
-
*
|
|
876
|
-
*
|
|
887
|
+
* Terminates the active MQTT connection identified by sessionID. The realm must match the session owner's realm. Authenticated users may disconnect their own sessions without an additional client role. Disconnecting another user's session requires the openremote client role write:admin or superuser status. Non-superusers are limited to their own active realm; superusers may disconnect sessions across realms, including inactive realms.
|
|
888
|
+
* Response code 403 - The realm is inactive for a non-superuser, or the caller is neither the session owner, a user with write:admin, nor a superuser
|
|
889
|
+
* Response code 404 - The session or its owning user does not exist, or the session does not belong to the specified realm
|
|
890
|
+
* Response code 405 - A non-superuser cannot access the session owner's realm
|
|
891
|
+
* HTTP DELETE /user/{realm}/disconnect/{sessionID}
|
|
892
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
877
893
|
*/
|
|
878
|
-
|
|
879
|
-
targetId?: string;
|
|
880
|
-
}, options?: O): RestResponse<void>;
|
|
894
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
881
895
|
/**
|
|
882
|
-
*
|
|
883
|
-
*
|
|
884
|
-
*
|
|
896
|
+
* Asks the identity provider to send or initiate its configured password-reset action for the specified user. The target realm must be active unless the caller is a superuser.
|
|
897
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
898
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
899
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
885
900
|
*/
|
|
886
|
-
|
|
887
|
-
targetId?: string;
|
|
888
|
-
}, options?: O): RestResponse<void>;
|
|
889
|
-
}
|
|
890
|
-
export declare class AssetResourceClient<O> {
|
|
891
|
-
protected httpClient: HttpClient<O>;
|
|
892
|
-
constructor(httpClient: HttpClient<O>);
|
|
901
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
893
902
|
/**
|
|
894
|
-
*
|
|
895
|
-
*
|
|
896
|
-
*
|
|
903
|
+
* Replaces a user's credential in an administered realm using the supplied credential representation. The target realm must be active unless the caller is a superuser.
|
|
904
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
905
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
906
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
897
907
|
*/
|
|
898
|
-
|
|
908
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
899
909
|
/**
|
|
900
|
-
*
|
|
901
|
-
* HTTP
|
|
902
|
-
* Java method: org.openremote.model.
|
|
910
|
+
* Generates and returns a new client secret for a service user in an administered realm. The target realm must be active unless the caller is a superuser.
|
|
911
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
912
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
903
913
|
*/
|
|
904
|
-
|
|
905
|
-
assetId?: string[];
|
|
906
|
-
}, options?: O): RestResponse<void>;
|
|
914
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
907
915
|
/**
|
|
908
|
-
*
|
|
909
|
-
* HTTP PUT /
|
|
910
|
-
* Java method: org.openremote.model.
|
|
916
|
+
* Creates, updates, or removes role definitions for the default OpenRemote client in the requested realm. The target realm must be active unless the caller is a superuser.
|
|
917
|
+
* HTTP PUT /user/{realm}/roles
|
|
918
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
911
919
|
*/
|
|
912
|
-
|
|
920
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
913
921
|
/**
|
|
914
|
-
*
|
|
915
|
-
* HTTP
|
|
916
|
-
* Java method: org.openremote.model.
|
|
922
|
+
* Returns realm-level role names assigned to one user. Without read-admin permission, callers may retrieve only their own roles. The target realm must be active unless the caller is a superuser.
|
|
923
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
924
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
917
925
|
*/
|
|
918
|
-
|
|
926
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
919
927
|
/**
|
|
920
|
-
*
|
|
921
|
-
* HTTP
|
|
922
|
-
* Java method: org.openremote.model.
|
|
928
|
+
* Replaces the user's assigned realm-level role names in an administered realm. The target realm must be active unless the caller is a superuser.
|
|
929
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
930
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
923
931
|
*/
|
|
924
|
-
|
|
932
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
925
933
|
/**
|
|
926
|
-
*
|
|
927
|
-
* HTTP
|
|
928
|
-
* Java method: org.openremote.model.
|
|
934
|
+
* Returns role names assigned to one user for the named client. Without read-admin permission, callers may retrieve only their own roles. The target realm must be active unless the caller is a superuser.
|
|
935
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
936
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
929
937
|
*/
|
|
930
|
-
|
|
931
|
-
assetIds?: string[];
|
|
932
|
-
}, options?: O): RestResponse<void>;
|
|
938
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
933
939
|
/**
|
|
934
|
-
*
|
|
935
|
-
* HTTP
|
|
936
|
-
* Java method: org.openremote.model.
|
|
940
|
+
* Replaces the user's assigned role names for the named client in an administered realm. The target realm must be active unless the caller is a superuser.
|
|
941
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
942
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
937
943
|
*/
|
|
938
|
-
|
|
944
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
939
945
|
/**
|
|
940
|
-
*
|
|
941
|
-
* HTTP
|
|
942
|
-
* Java method: org.openremote.model.
|
|
946
|
+
* Returns active MQTT sessions for one user, including connection ID, creation time, and remote address. Without read-admin permission, callers may inspect only themselves. The target realm must be active unless the caller is a superuser.
|
|
947
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
948
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
943
949
|
*/
|
|
944
|
-
|
|
950
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
945
951
|
/**
|
|
946
|
-
*
|
|
947
|
-
* HTTP POST /
|
|
948
|
-
* Java method: org.openremote.model.
|
|
952
|
+
* Creates an identity-provider user in a realm administered by the caller and returns the resulting user record. The target realm must be active unless the caller is a superuser.
|
|
953
|
+
* HTTP POST /user/{realm}/users
|
|
954
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
949
955
|
*/
|
|
950
|
-
|
|
956
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
951
957
|
/**
|
|
952
|
-
*
|
|
953
|
-
*
|
|
954
|
-
*
|
|
958
|
+
* Updates an existing identity-provider user in an administered realm. The master administrator cannot be disabled. The target realm must be active unless the caller is a superuser.
|
|
959
|
+
* Response code 405 - The requested cross-realm or protected master-administrator mutation is not allowed
|
|
960
|
+
* HTTP PUT /user/{realm}/users
|
|
961
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
955
962
|
*/
|
|
956
|
-
|
|
963
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
957
964
|
/**
|
|
958
|
-
*
|
|
959
|
-
*
|
|
960
|
-
*
|
|
965
|
+
* Permanently deletes a user from an administered realm. The master-realm administrator cannot be deleted. The target realm must be active unless the caller is a superuser.
|
|
966
|
+
* Response code 405 - The master-realm administrator cannot be deleted
|
|
967
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
968
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
961
969
|
*/
|
|
962
|
-
|
|
970
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
963
971
|
/**
|
|
964
|
-
* Returns
|
|
965
|
-
* HTTP GET /
|
|
966
|
-
* Java method: org.openremote.model.
|
|
972
|
+
* Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required. The target realm must be active unless the caller is a superuser.
|
|
973
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
974
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
967
975
|
*/
|
|
968
|
-
|
|
969
|
-
realm?: string;
|
|
970
|
-
userId?: string;
|
|
971
|
-
assetId?: string;
|
|
972
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
976
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
973
977
|
/**
|
|
974
|
-
*
|
|
975
|
-
* HTTP
|
|
976
|
-
* Java method: org.openremote.model.
|
|
978
|
+
* Creates, updates, or removes role definitions for a named identity-provider client. The target realm must be active unless the caller is a superuser.
|
|
979
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
980
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
977
981
|
*/
|
|
978
|
-
|
|
982
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
979
983
|
/**
|
|
980
|
-
*
|
|
981
|
-
* HTTP
|
|
982
|
-
* Java method: org.openremote.model.
|
|
984
|
+
* Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user. The target realm must be active unless the caller is a superuser.
|
|
985
|
+
* HTTP GET /user/{realm}/{userId}
|
|
986
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
983
987
|
*/
|
|
984
|
-
|
|
988
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
989
|
+
}
|
|
990
|
+
export declare class AssetModelResourceClient<O> {
|
|
991
|
+
protected httpClient: HttpClient<O>;
|
|
992
|
+
constructor(httpClient: HttpClient<O>);
|
|
985
993
|
/**
|
|
986
|
-
*
|
|
987
|
-
* HTTP
|
|
988
|
-
* Java method: org.openremote.model.asset.
|
|
994
|
+
* Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
|
|
995
|
+
* HTTP GET /model/assetDescriptors
|
|
996
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
989
997
|
*/
|
|
990
|
-
|
|
998
|
+
getAssetDescriptors(queryParams?: {
|
|
999
|
+
parentId?: string;
|
|
1000
|
+
parentType?: string;
|
|
1001
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
991
1002
|
/**
|
|
992
|
-
* Returns
|
|
993
|
-
*
|
|
994
|
-
*
|
|
1003
|
+
* Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
|
|
1004
|
+
* Response code 204 - No model information is available for the requested asset type
|
|
1005
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
1006
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
995
1007
|
*/
|
|
996
|
-
|
|
1008
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
1009
|
+
parentId?: string;
|
|
1010
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
997
1011
|
/**
|
|
998
|
-
*
|
|
999
|
-
* HTTP
|
|
1000
|
-
* Java method: org.openremote.model.asset.
|
|
1012
|
+
* Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
|
|
1013
|
+
* HTTP GET /model/assetInfos
|
|
1014
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
1001
1015
|
*/
|
|
1002
|
-
|
|
1016
|
+
getAssetInfos(queryParams?: {
|
|
1017
|
+
parentId?: string;
|
|
1018
|
+
parentType?: string;
|
|
1019
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
1003
1020
|
/**
|
|
1004
|
-
*
|
|
1005
|
-
* Response code
|
|
1006
|
-
* Response code
|
|
1007
|
-
*
|
|
1008
|
-
*
|
|
1009
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
1021
|
+
* Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
|
|
1022
|
+
* Response code 200 - The current JSON Schema
|
|
1023
|
+
* Response code 304 - The supplied ETag still identifies the current schema
|
|
1024
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
1025
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
1010
1026
|
*/
|
|
1011
|
-
|
|
1027
|
+
getValueDescriptorSchema(queryParams?: {
|
|
1028
|
+
name?: string;
|
|
1029
|
+
}, options?: O): RestResponse<any>;
|
|
1012
1030
|
/**
|
|
1013
|
-
*
|
|
1014
|
-
*
|
|
1015
|
-
*
|
|
1016
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
1017
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
1018
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
1031
|
+
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
1032
|
+
* HTTP GET /model/metaItemDescriptors
|
|
1033
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
1019
1034
|
*/
|
|
1020
|
-
|
|
1035
|
+
getMetaItemDescriptors(queryParams?: {
|
|
1036
|
+
parentId?: string;
|
|
1037
|
+
}, options?: O): RestResponse<{
|
|
1038
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
1039
|
+
}>;
|
|
1021
1040
|
/**
|
|
1022
|
-
*
|
|
1023
|
-
* HTTP
|
|
1024
|
-
* Java method: org.openremote.model.asset.
|
|
1041
|
+
* Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
1042
|
+
* HTTP GET /model/valueDescriptors
|
|
1043
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
1025
1044
|
*/
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
}, options?: O): RestResponse<
|
|
1045
|
+
getValueDescriptors(queryParams?: {
|
|
1046
|
+
parentId?: string;
|
|
1047
|
+
}, options?: O): RestResponse<{
|
|
1048
|
+
[index: string]: Model.ValueDescriptor;
|
|
1049
|
+
}>;
|
|
1029
1050
|
}
|
|
1030
|
-
export declare class
|
|
1051
|
+
export declare class AppResourceClient<O> {
|
|
1031
1052
|
protected httpClient: HttpClient<O>;
|
|
1032
1053
|
constructor(httpClient: HttpClient<O>);
|
|
1033
1054
|
/**
|
|
1034
|
-
* Returns the
|
|
1035
|
-
* HTTP GET /
|
|
1036
|
-
* Java method: org.openremote.model.
|
|
1037
|
-
*/
|
|
1038
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
1039
|
-
/**
|
|
1040
|
-
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
|
|
1041
|
-
* HTTP PUT /configuration/manager
|
|
1042
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
1055
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
1056
|
+
* HTTP GET /apps
|
|
1057
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
1043
1058
|
*/
|
|
1044
|
-
|
|
1059
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
1045
1060
|
/**
|
|
1046
|
-
*
|
|
1047
|
-
* HTTP
|
|
1048
|
-
* Java method: org.openremote.model.
|
|
1061
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
1062
|
+
* HTTP GET /apps/consoleConfig
|
|
1063
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
1049
1064
|
*/
|
|
1050
|
-
|
|
1051
|
-
path?: string;
|
|
1052
|
-
}, options?: O): RestResponse<string>;
|
|
1065
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
1053
1066
|
/**
|
|
1054
|
-
*
|
|
1055
|
-
*
|
|
1056
|
-
*
|
|
1057
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
1067
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
1068
|
+
* HTTP GET /apps/info
|
|
1069
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
1058
1070
|
*/
|
|
1059
|
-
|
|
1071
|
+
getAppInfos(options?: O): RestResponse<{
|
|
1072
|
+
[index: string]: any;
|
|
1073
|
+
}>;
|
|
1060
1074
|
}
|
|
1061
|
-
export declare class
|
|
1075
|
+
export declare class GatewayClientResourceClient<O> {
|
|
1062
1076
|
protected httpClient: HttpClient<O>;
|
|
1063
1077
|
constructor(httpClient: HttpClient<O>);
|
|
1064
1078
|
/**
|
|
1065
|
-
*
|
|
1066
|
-
* HTTP
|
|
1067
|
-
* Java method: org.openremote.model.
|
|
1079
|
+
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
1080
|
+
* HTTP DELETE /gateway/connection
|
|
1081
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
1068
1082
|
*/
|
|
1069
|
-
|
|
1083
|
+
deleteConnections(queryParams?: {
|
|
1084
|
+
realm?: string[];
|
|
1085
|
+
}, options?: O): RestResponse<void>;
|
|
1070
1086
|
/**
|
|
1071
|
-
*
|
|
1072
|
-
* HTTP
|
|
1073
|
-
* Java method: org.openremote.model.
|
|
1087
|
+
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
1088
|
+
* HTTP GET /gateway/connection
|
|
1089
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
1074
1090
|
*/
|
|
1075
|
-
|
|
1091
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
1076
1092
|
/**
|
|
1077
|
-
*
|
|
1078
|
-
* HTTP
|
|
1079
|
-
* Java method: org.openremote.model.
|
|
1093
|
+
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
1094
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
1095
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
1080
1096
|
*/
|
|
1081
|
-
|
|
1097
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
1082
1098
|
/**
|
|
1083
|
-
*
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
1099
|
+
* Returns the central-manager connection configured for a realm, or null when none exists. Realm administrators can read their own realm; super users can read any realm.
|
|
1100
|
+
* Response code 204 - No gateway connection is configured for the realm
|
|
1101
|
+
* HTTP GET /gateway/connection/{realm}
|
|
1102
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
1086
1103
|
*/
|
|
1087
|
-
|
|
1104
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
1088
1105
|
/**
|
|
1089
|
-
*
|
|
1090
|
-
* HTTP
|
|
1091
|
-
* Java method: org.openremote.model.
|
|
1106
|
+
* Creates or replaces the connection for the path realm. The server forces the local realm, including realm predicates in attribute filters, to match the path.
|
|
1107
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
1108
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
1092
1109
|
*/
|
|
1093
|
-
|
|
1110
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
1094
1111
|
/**
|
|
1095
|
-
* Returns
|
|
1096
|
-
* HTTP GET /
|
|
1097
|
-
* Java method: org.openremote.model.
|
|
1112
|
+
* Returns the live connection state for the requested local realm.
|
|
1113
|
+
* HTTP GET /gateway/status/{realm}
|
|
1114
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
1098
1115
|
*/
|
|
1099
|
-
|
|
1116
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
1100
1117
|
}
|
|
1101
|
-
export declare class
|
|
1118
|
+
export declare class StatusResourceClient<O> {
|
|
1102
1119
|
protected httpClient: HttpClient<O>;
|
|
1103
1120
|
constructor(httpClient: HttpClient<O>);
|
|
1104
1121
|
/**
|
|
1105
|
-
*
|
|
1106
|
-
* HTTP
|
|
1107
|
-
* Java method: org.openremote.model.
|
|
1108
|
-
*/
|
|
1109
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
1110
|
-
assetIds?: string[];
|
|
1111
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
1112
|
-
/**
|
|
1113
|
-
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
1114
|
-
* HTTP GET /alarm
|
|
1115
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
1122
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
1123
|
+
* HTTP GET /health
|
|
1124
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
1116
1125
|
*/
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
assetId?: string;
|
|
1121
|
-
assigneeId?: string;
|
|
1122
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
1126
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
1127
|
+
[index: string]: any;
|
|
1128
|
+
}>;
|
|
1123
1129
|
/**
|
|
1124
|
-
*
|
|
1125
|
-
* HTTP
|
|
1126
|
-
* Java method: org.openremote.model.
|
|
1130
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
1131
|
+
* HTTP GET /info
|
|
1132
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
1127
1133
|
*/
|
|
1128
|
-
|
|
1134
|
+
getInfo(options?: O): RestResponse<{
|
|
1135
|
+
[index: string]: any;
|
|
1136
|
+
}>;
|
|
1137
|
+
}
|
|
1138
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
1139
|
+
protected httpClient: HttpClient<O>;
|
|
1140
|
+
constructor(httpClient: HttpClient<O>);
|
|
1129
1141
|
/**
|
|
1130
|
-
*
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
1135
|
-
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
1136
|
-
|
|
1137
|
-
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
1138
|
-
This operation does not remove existing links from the alarm.
|
|
1139
|
-
|
|
1140
|
-
* HTTP PUT /alarm/assets
|
|
1141
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
1142
|
+
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
1143
|
+
* Response code 417 - The gateway could not establish the requested tunnel
|
|
1144
|
+
* HTTP POST /gateway/tunnel
|
|
1145
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
1142
1146
|
*/
|
|
1143
|
-
|
|
1147
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
1144
1148
|
/**
|
|
1145
|
-
*
|
|
1146
|
-
* HTTP
|
|
1147
|
-
* Java method: org.openremote.model.
|
|
1149
|
+
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
1150
|
+
* HTTP DELETE /gateway/tunnel
|
|
1151
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
1148
1152
|
*/
|
|
1149
|
-
|
|
1153
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
1150
1154
|
/**
|
|
1151
|
-
*
|
|
1152
|
-
* HTTP
|
|
1153
|
-
* Java method: org.openremote.model.
|
|
1155
|
+
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
1156
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
1157
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
1154
1158
|
*/
|
|
1155
|
-
|
|
1159
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
1156
1160
|
/**
|
|
1157
|
-
*
|
|
1158
|
-
* HTTP
|
|
1159
|
-
* Java method: org.openremote.model.
|
|
1161
|
+
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
1162
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
1163
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
1160
1164
|
*/
|
|
1161
|
-
|
|
1165
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
1162
1166
|
/**
|
|
1163
|
-
* Returns
|
|
1164
|
-
*
|
|
1165
|
-
*
|
|
1167
|
+
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
1168
|
+
* Response code 204 - No active tunnel matches the requested endpoint
|
|
1169
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
1170
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
1166
1171
|
*/
|
|
1167
|
-
|
|
1168
|
-
realm?: string;
|
|
1169
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
1172
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
1170
1173
|
}
|
|
1171
1174
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1172
1175
|
export declare class ApiClient {
|
|
1173
|
-
protected
|
|
1174
|
-
protected
|
|
1175
|
-
protected
|
|
1176
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
1177
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1178
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
1179
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1180
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1181
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1176
1182
|
protected _agentResource: AxiosAgentResourceClient;
|
|
1177
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1178
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
1179
1183
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1180
|
-
protected
|
|
1181
|
-
protected
|
|
1182
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1184
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1185
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1183
1186
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1184
|
-
protected
|
|
1185
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
1186
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
1187
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1187
1188
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1188
|
-
protected _userResource: AxiosUserResourceClient;
|
|
1189
1189
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
1190
|
-
protected
|
|
1191
|
-
protected
|
|
1192
|
-
protected
|
|
1193
|
-
protected
|
|
1194
|
-
protected
|
|
1190
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1191
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
1192
|
+
protected _userResource: AxiosUserResourceClient;
|
|
1193
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1194
|
+
protected _appResource: AxiosAppResourceClient;
|
|
1195
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1196
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
1197
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1195
1198
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1196
|
-
get
|
|
1197
|
-
get
|
|
1198
|
-
get
|
|
1199
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1200
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1201
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1202
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1203
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1204
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1199
1205
|
get AgentResource(): AxiosAgentResourceClient;
|
|
1200
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1201
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1202
1206
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1203
|
-
get
|
|
1204
|
-
get
|
|
1205
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1207
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1208
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1206
1209
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1207
|
-
get
|
|
1208
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1209
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1210
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1210
1211
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1211
|
-
get UserResource(): AxiosUserResourceClient;
|
|
1212
1212
|
get RulesResource(): AxiosRulesResourceClient;
|
|
1213
|
-
get
|
|
1214
|
-
get
|
|
1215
|
-
get
|
|
1216
|
-
get
|
|
1217
|
-
get
|
|
1213
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1214
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1215
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1216
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1217
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1218
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1219
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1220
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1218
1221
|
}
|
|
1219
1222
|
import * as Axios from "axios";
|
|
1220
1223
|
declare module "axios" {
|
|
@@ -1222,70 +1225,70 @@ declare module "axios" {
|
|
|
1222
1225
|
data: R;
|
|
1223
1226
|
}
|
|
1224
1227
|
}
|
|
1225
|
-
export declare class
|
|
1228
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1226
1229
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1227
1230
|
}
|
|
1228
|
-
export declare class
|
|
1231
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1229
1232
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1230
1233
|
}
|
|
1231
|
-
export declare class
|
|
1234
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1232
1235
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1233
1236
|
}
|
|
1234
|
-
export declare class
|
|
1237
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1235
1238
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1236
1239
|
}
|
|
1237
|
-
export declare class
|
|
1240
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1238
1241
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1239
1242
|
}
|
|
1240
|
-
export declare class
|
|
1243
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1241
1244
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1242
1245
|
}
|
|
1243
|
-
export declare class
|
|
1246
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1244
1247
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1245
1248
|
}
|
|
1246
|
-
export declare class
|
|
1249
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1247
1250
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1248
1251
|
}
|
|
1249
|
-
export declare class
|
|
1252
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1250
1253
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1251
1254
|
}
|
|
1252
|
-
export declare class
|
|
1255
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1253
1256
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1254
1257
|
}
|
|
1255
1258
|
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1256
1259
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1257
1260
|
}
|
|
1258
|
-
export declare class
|
|
1261
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1259
1262
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1260
1263
|
}
|
|
1261
|
-
export declare class
|
|
1264
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1262
1265
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1263
1266
|
}
|
|
1264
|
-
export declare class
|
|
1267
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1265
1268
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1266
1269
|
}
|
|
1267
|
-
export declare class
|
|
1270
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1268
1271
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1269
1272
|
}
|
|
1270
|
-
export declare class
|
|
1273
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1271
1274
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1272
1275
|
}
|
|
1273
|
-
export declare class
|
|
1276
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1274
1277
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1275
1278
|
}
|
|
1276
|
-
export declare class
|
|
1279
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1277
1280
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1278
1281
|
}
|
|
1279
|
-
export declare class
|
|
1282
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1280
1283
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1281
1284
|
}
|
|
1282
|
-
export declare class
|
|
1285
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1283
1286
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1284
1287
|
}
|
|
1285
|
-
export declare class
|
|
1288
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1286
1289
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1287
1290
|
}
|
|
1288
|
-
export declare class
|
|
1291
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1289
1292
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1290
1293
|
}
|
|
1291
1294
|
//# sourceMappingURL=restclient.d.ts.map
|