@openremote/rest 1.34.0 → 1.35.0-snapshot.20261109083019
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,226 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class RealmResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
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
|
-
*/
|
|
20
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
21
|
-
/**
|
|
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
|
-
*/
|
|
26
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
27
|
-
/**
|
|
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
|
-
*/
|
|
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
|
-
* Response code 409 - Realm cannot be deleted while it still contains assets
|
|
37
|
-
* HTTP DELETE /realm/{name}
|
|
38
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
39
|
-
*/
|
|
40
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
41
|
-
/**
|
|
42
|
-
* 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.
|
|
43
|
-
* HTTP GET /realm/{name}
|
|
44
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
45
|
-
*/
|
|
46
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
47
|
-
/**
|
|
48
|
-
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
49
|
-
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
50
|
-
* HTTP PUT /realm/{name}
|
|
51
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
52
|
-
*/
|
|
53
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
54
|
-
}
|
|
55
|
-
export declare class AgentResourceClient<O> {
|
|
56
|
-
protected httpClient: HttpClient<O>;
|
|
57
|
-
constructor(httpClient: HttpClient<O>);
|
|
58
|
-
/**
|
|
59
|
-
* 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.
|
|
60
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
61
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
62
|
-
*/
|
|
63
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
64
|
-
realm?: string;
|
|
65
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
66
|
-
/**
|
|
67
|
-
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
68
|
-
* Response code 405 - The selected agent protocol does not support asset import
|
|
69
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
70
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
71
|
-
*/
|
|
72
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
73
|
-
realm?: string;
|
|
74
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
75
|
-
/**
|
|
76
|
-
* 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.
|
|
77
|
-
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
78
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
79
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
80
|
-
*/
|
|
81
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
82
|
-
parentId?: string;
|
|
83
|
-
realm?: string;
|
|
84
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
85
|
-
}
|
|
86
|
-
export declare class NotificationResourceClient<O> {
|
|
87
|
-
protected httpClient: HttpClient<O>;
|
|
88
|
-
constructor(httpClient: HttpClient<O>);
|
|
89
|
-
/**
|
|
90
|
-
* 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.
|
|
91
|
-
* HTTP GET /notification
|
|
92
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
93
|
-
*/
|
|
94
|
-
getNotifications(queryParams?: {
|
|
95
|
-
id?: number;
|
|
96
|
-
type?: string;
|
|
97
|
-
from?: number;
|
|
98
|
-
to?: number;
|
|
99
|
-
realmId?: string;
|
|
100
|
-
userId?: string;
|
|
101
|
-
assetId?: string;
|
|
102
|
-
source?: Model.NotificationSource;
|
|
103
|
-
sort?: Model.SentNotificationSortField;
|
|
104
|
-
descending?: boolean;
|
|
105
|
-
offset?: number;
|
|
106
|
-
limit?: number;
|
|
107
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
108
|
-
/**
|
|
109
|
-
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
110
|
-
* HTTP DELETE /notification
|
|
111
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
112
|
-
*/
|
|
113
|
-
removeNotifications(queryParams?: {
|
|
114
|
-
id?: number;
|
|
115
|
-
type?: string;
|
|
116
|
-
from?: number;
|
|
117
|
-
to?: number;
|
|
118
|
-
realmId?: string;
|
|
119
|
-
userId?: string;
|
|
120
|
-
assetId?: string;
|
|
121
|
-
}, options?: O): RestResponse<void>;
|
|
122
|
-
/**
|
|
123
|
-
* 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.
|
|
124
|
-
* HTTP POST /notification/alert
|
|
125
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
126
|
-
*/
|
|
127
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
128
|
-
/**
|
|
129
|
-
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
130
|
-
* HTTP GET /notification/count
|
|
131
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
132
|
-
*/
|
|
133
|
-
getNotificationsCount(queryParams?: {
|
|
134
|
-
type?: string;
|
|
135
|
-
from?: number;
|
|
136
|
-
to?: number;
|
|
137
|
-
realmId?: string;
|
|
138
|
-
userId?: string;
|
|
139
|
-
assetId?: string;
|
|
140
|
-
source?: Model.NotificationSource;
|
|
141
|
-
}, options?: O): RestResponse<number>;
|
|
142
|
-
/**
|
|
143
|
-
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
144
|
-
* HTTP DELETE /notification/{notificationId}
|
|
145
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
146
|
-
*/
|
|
147
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
148
|
-
/**
|
|
149
|
-
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
150
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
151
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
152
|
-
*/
|
|
153
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
154
|
-
targetId?: string;
|
|
155
|
-
}, options?: O): RestResponse<void>;
|
|
156
|
-
/**
|
|
157
|
-
* 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.
|
|
158
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
159
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
160
|
-
*/
|
|
161
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
162
|
-
targetId?: string;
|
|
163
|
-
}, options?: O): RestResponse<void>;
|
|
164
|
-
}
|
|
165
|
-
export declare class ConfigurationResourceClient<O> {
|
|
166
|
-
protected httpClient: HttpClient<O>;
|
|
167
|
-
constructor(httpClient: HttpClient<O>);
|
|
168
|
-
/**
|
|
169
|
-
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
170
|
-
* HTTP GET /configuration/manager
|
|
171
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
172
|
-
*/
|
|
173
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
174
|
-
/**
|
|
175
|
-
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior. This operation is restricted to a super administrator.
|
|
176
|
-
* HTTP PUT /configuration/manager
|
|
177
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
178
|
-
*/
|
|
179
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
180
|
-
/**
|
|
181
|
-
* Validates and stores the supplied image FileInfo at the requested relative path, replacing an existing image, then returns its Manager API path. This operation is restricted to a super administrator.
|
|
182
|
-
* HTTP POST /configuration/manager/image
|
|
183
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.imageUpload
|
|
184
|
-
*/
|
|
185
|
-
imageUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
186
|
-
path?: string;
|
|
187
|
-
}, options?: O): RestResponse<string>;
|
|
188
|
-
/**
|
|
189
|
-
* Streams a configuration image using a fixed media type determined by its filename extension. Only png, jpg, jpeg, ico, and svg extensions are served, ignoring case; unsupported extensions return 404.
|
|
190
|
-
* Response code 200 - The image file
|
|
191
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
192
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
193
|
-
*/
|
|
194
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
195
|
-
}
|
|
196
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
197
|
-
protected httpClient: HttpClient<O>;
|
|
198
|
-
constructor(httpClient: HttpClient<O>);
|
|
199
|
-
/**
|
|
200
|
-
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
201
|
-
* Response code 417 - The gateway could not establish the requested tunnel
|
|
202
|
-
* HTTP POST /gateway/tunnel
|
|
203
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
204
|
-
*/
|
|
205
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
206
|
-
/**
|
|
207
|
-
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
208
|
-
* HTTP DELETE /gateway/tunnel
|
|
209
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
210
|
-
*/
|
|
211
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
212
|
-
/**
|
|
213
|
-
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
214
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
215
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
216
|
-
*/
|
|
217
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
218
|
-
/**
|
|
219
|
-
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
220
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
221
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
222
|
-
*/
|
|
223
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
224
|
-
/**
|
|
225
|
-
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
226
|
-
* Response code 204 - No active tunnel matches the requested endpoint
|
|
227
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
228
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
229
|
-
*/
|
|
230
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
231
|
-
}
|
|
232
12
|
export declare class RulesResourceClient<O> {
|
|
233
13
|
protected httpClient: HttpClient<O>;
|
|
234
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -359,29 +139,323 @@ export declare class RulesResourceClient<O> {
|
|
|
359
139
|
*/
|
|
360
140
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
361
141
|
}
|
|
362
|
-
export declare class
|
|
142
|
+
export declare class StatusResourceClient<O> {
|
|
363
143
|
protected httpClient: HttpClient<O>;
|
|
364
144
|
constructor(httpClient: HttpClient<O>);
|
|
365
145
|
/**
|
|
366
|
-
*
|
|
367
|
-
* HTTP
|
|
368
|
-
* Java method: org.openremote.model.
|
|
146
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
147
|
+
* HTTP GET /health
|
|
148
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
369
149
|
*/
|
|
370
|
-
|
|
150
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
151
|
+
[index: string]: any;
|
|
152
|
+
}>;
|
|
371
153
|
/**
|
|
372
|
-
*
|
|
373
|
-
* HTTP
|
|
374
|
-
* Java method: org.openremote.model.
|
|
154
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
155
|
+
* HTTP GET /info
|
|
156
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
375
157
|
*/
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
}
|
|
158
|
+
getInfo(options?: O): RestResponse<{
|
|
159
|
+
[index: string]: any;
|
|
160
|
+
}>;
|
|
161
|
+
}
|
|
162
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
163
|
+
protected httpClient: HttpClient<O>;
|
|
164
|
+
constructor(httpClient: HttpClient<O>);
|
|
379
165
|
/**
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
166
|
+
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
167
|
+
* Response code 200 - List of registered external services
|
|
168
|
+
* HTTP GET /service
|
|
169
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
383
170
|
*/
|
|
384
|
-
|
|
171
|
+
getServices(queryParams?: {
|
|
172
|
+
realm?: string;
|
|
173
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
174
|
+
/**
|
|
175
|
+
* 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.
|
|
176
|
+
* Response code 200 - Service registered successfully
|
|
177
|
+
* Response code 400 - Invalid external service object
|
|
178
|
+
* Response code 409 - ExternalService instance already registered
|
|
179
|
+
* HTTP POST /service
|
|
180
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
181
|
+
*/
|
|
182
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
183
|
+
/**
|
|
184
|
+
* Returns active registrations marked as globally available across realms.
|
|
185
|
+
* Response code 200 - List of registered external services
|
|
186
|
+
* HTTP GET /service/global
|
|
187
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
188
|
+
*/
|
|
189
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
190
|
+
/**
|
|
191
|
+
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
192
|
+
* Response code 200 - Service registered successfully
|
|
193
|
+
* Response code 400 - Invalid external service object
|
|
194
|
+
* Response code 409 - ExternalService instance already registered
|
|
195
|
+
* HTTP POST /service/global
|
|
196
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
197
|
+
*/
|
|
198
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
199
|
+
/**
|
|
200
|
+
* Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
|
|
201
|
+
* Response code 204 - Service deregistered successfully
|
|
202
|
+
* Response code 404 - Service instance not found
|
|
203
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
204
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
205
|
+
*/
|
|
206
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
207
|
+
/**
|
|
208
|
+
* Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
|
|
209
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
210
|
+
* Response code 404 - ExternalService not found
|
|
211
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
212
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
213
|
+
*/
|
|
214
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
215
|
+
/**
|
|
216
|
+
* 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.
|
|
217
|
+
* Response code 204 - Heartbeat sent successfully
|
|
218
|
+
* Response code 404 - Service instance not found
|
|
219
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
220
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
221
|
+
*/
|
|
222
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
223
|
+
}
|
|
224
|
+
export declare class RealmResourceClient<O> {
|
|
225
|
+
protected httpClient: HttpClient<O>;
|
|
226
|
+
constructor(httpClient: HttpClient<O>);
|
|
227
|
+
/**
|
|
228
|
+
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
229
|
+
* HTTP POST /realm
|
|
230
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
231
|
+
*/
|
|
232
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
233
|
+
/**
|
|
234
|
+
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
235
|
+
* HTTP GET /realm
|
|
236
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
237
|
+
*/
|
|
238
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
239
|
+
/**
|
|
240
|
+
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
241
|
+
* HTTP GET /realm/accessible
|
|
242
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
243
|
+
*/
|
|
244
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
245
|
+
/**
|
|
246
|
+
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
247
|
+
* Response code 405 - The master realm cannot be deleted
|
|
248
|
+
* Response code 409 - Realm cannot be deleted while it still contains assets
|
|
249
|
+
* HTTP DELETE /realm/{name}
|
|
250
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
251
|
+
*/
|
|
252
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
253
|
+
/**
|
|
254
|
+
* 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.
|
|
255
|
+
* HTTP GET /realm/{name}
|
|
256
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
257
|
+
*/
|
|
258
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
259
|
+
/**
|
|
260
|
+
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
261
|
+
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
262
|
+
* HTTP PUT /realm/{name}
|
|
263
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
264
|
+
*/
|
|
265
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
266
|
+
}
|
|
267
|
+
export declare class AgentResourceClient<O> {
|
|
268
|
+
protected httpClient: HttpClient<O>;
|
|
269
|
+
constructor(httpClient: HttpClient<O>);
|
|
270
|
+
/**
|
|
271
|
+
* 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.
|
|
272
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
273
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
274
|
+
*/
|
|
275
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
276
|
+
realm?: string;
|
|
277
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
278
|
+
/**
|
|
279
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
280
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
281
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
282
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
283
|
+
*/
|
|
284
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
285
|
+
realm?: string;
|
|
286
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
287
|
+
/**
|
|
288
|
+
* 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.
|
|
289
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
290
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
291
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
292
|
+
*/
|
|
293
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
294
|
+
parentId?: string;
|
|
295
|
+
realm?: string;
|
|
296
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
297
|
+
}
|
|
298
|
+
export declare class ProvisioningResourceClient<O> {
|
|
299
|
+
protected httpClient: HttpClient<O>;
|
|
300
|
+
constructor(httpClient: HttpClient<O>);
|
|
301
|
+
/**
|
|
302
|
+
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
303
|
+
* HTTP POST /provisioning
|
|
304
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
305
|
+
*/
|
|
306
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
307
|
+
/**
|
|
308
|
+
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
309
|
+
* HTTP GET /provisioning
|
|
310
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
311
|
+
*/
|
|
312
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
313
|
+
/**
|
|
314
|
+
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
315
|
+
* HTTP DELETE /provisioning/{id}
|
|
316
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
317
|
+
*/
|
|
318
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
319
|
+
/**
|
|
320
|
+
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
321
|
+
* HTTP PUT /provisioning/{id}
|
|
322
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
323
|
+
*/
|
|
324
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
325
|
+
}
|
|
326
|
+
export declare class ConfigurationResourceClient<O> {
|
|
327
|
+
protected httpClient: HttpClient<O>;
|
|
328
|
+
constructor(httpClient: HttpClient<O>);
|
|
329
|
+
/**
|
|
330
|
+
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
331
|
+
* HTTP GET /configuration/manager
|
|
332
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
333
|
+
*/
|
|
334
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
335
|
+
/**
|
|
336
|
+
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior. This operation is restricted to a super administrator.
|
|
337
|
+
* HTTP PUT /configuration/manager
|
|
338
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
339
|
+
*/
|
|
340
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
341
|
+
/**
|
|
342
|
+
* Validates and stores the supplied image FileInfo at the requested relative path, replacing an existing image, then returns its Manager API path. This operation is restricted to a super administrator.
|
|
343
|
+
* HTTP POST /configuration/manager/image
|
|
344
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.imageUpload
|
|
345
|
+
*/
|
|
346
|
+
imageUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
347
|
+
path?: string;
|
|
348
|
+
}, options?: O): RestResponse<string>;
|
|
349
|
+
/**
|
|
350
|
+
* Streams a configuration image using a fixed media type determined by its filename extension. Only png, jpg, jpeg, ico, and svg extensions are served, ignoring case; unsupported extensions return 404.
|
|
351
|
+
* Response code 200 - The image file
|
|
352
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
353
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
354
|
+
*/
|
|
355
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
356
|
+
}
|
|
357
|
+
export declare class NotificationResourceClient<O> {
|
|
358
|
+
protected httpClient: HttpClient<O>;
|
|
359
|
+
constructor(httpClient: HttpClient<O>);
|
|
360
|
+
/**
|
|
361
|
+
* 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.
|
|
362
|
+
* HTTP GET /notification
|
|
363
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
364
|
+
*/
|
|
365
|
+
getNotifications(queryParams?: {
|
|
366
|
+
id?: number;
|
|
367
|
+
type?: string;
|
|
368
|
+
from?: number;
|
|
369
|
+
to?: number;
|
|
370
|
+
realmId?: string;
|
|
371
|
+
userId?: string;
|
|
372
|
+
assetId?: string;
|
|
373
|
+
source?: Model.NotificationSource;
|
|
374
|
+
sort?: Model.SentNotificationSortField;
|
|
375
|
+
descending?: boolean;
|
|
376
|
+
offset?: number;
|
|
377
|
+
limit?: number;
|
|
378
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
379
|
+
/**
|
|
380
|
+
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
381
|
+
* HTTP DELETE /notification
|
|
382
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
383
|
+
*/
|
|
384
|
+
removeNotifications(queryParams?: {
|
|
385
|
+
id?: number;
|
|
386
|
+
type?: string;
|
|
387
|
+
from?: number;
|
|
388
|
+
to?: number;
|
|
389
|
+
realmId?: string;
|
|
390
|
+
userId?: string;
|
|
391
|
+
assetId?: string;
|
|
392
|
+
}, options?: O): RestResponse<void>;
|
|
393
|
+
/**
|
|
394
|
+
* 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.
|
|
395
|
+
* HTTP POST /notification/alert
|
|
396
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
397
|
+
*/
|
|
398
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
399
|
+
/**
|
|
400
|
+
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
401
|
+
* HTTP GET /notification/count
|
|
402
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
403
|
+
*/
|
|
404
|
+
getNotificationsCount(queryParams?: {
|
|
405
|
+
type?: string;
|
|
406
|
+
from?: number;
|
|
407
|
+
to?: number;
|
|
408
|
+
realmId?: string;
|
|
409
|
+
userId?: string;
|
|
410
|
+
assetId?: string;
|
|
411
|
+
source?: Model.NotificationSource;
|
|
412
|
+
}, options?: O): RestResponse<number>;
|
|
413
|
+
/**
|
|
414
|
+
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
415
|
+
* HTTP DELETE /notification/{notificationId}
|
|
416
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
417
|
+
*/
|
|
418
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
419
|
+
/**
|
|
420
|
+
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
421
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
422
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
423
|
+
*/
|
|
424
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
425
|
+
targetId?: string;
|
|
426
|
+
}, options?: O): RestResponse<void>;
|
|
427
|
+
/**
|
|
428
|
+
* 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.
|
|
429
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
430
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
431
|
+
*/
|
|
432
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
433
|
+
targetId?: string;
|
|
434
|
+
}, options?: O): RestResponse<void>;
|
|
435
|
+
}
|
|
436
|
+
export declare class AssetResourceClient<O> {
|
|
437
|
+
protected httpClient: HttpClient<O>;
|
|
438
|
+
constructor(httpClient: HttpClient<O>);
|
|
439
|
+
/**
|
|
440
|
+
* 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.
|
|
441
|
+
* HTTP POST /asset
|
|
442
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
443
|
+
*/
|
|
444
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
445
|
+
/**
|
|
446
|
+
* Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
|
|
447
|
+
* HTTP DELETE /asset
|
|
448
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
449
|
+
*/
|
|
450
|
+
delete(queryParams?: {
|
|
451
|
+
assetId?: string[];
|
|
452
|
+
}, options?: O): RestResponse<void>;
|
|
453
|
+
/**
|
|
454
|
+
* 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.
|
|
455
|
+
* HTTP PUT /asset/attributes
|
|
456
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
457
|
+
*/
|
|
458
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
385
459
|
/**
|
|
386
460
|
* 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.
|
|
387
461
|
* HTTP PUT /asset/attributes/timestamp
|
|
@@ -499,347 +573,310 @@ export declare class AssetResourceClient<O> {
|
|
|
499
573
|
assetIds?: string[];
|
|
500
574
|
}, options?: O): RestResponse<void>;
|
|
501
575
|
}
|
|
502
|
-
export declare class
|
|
576
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
503
577
|
protected httpClient: HttpClient<O>;
|
|
504
578
|
constructor(httpClient: HttpClient<O>);
|
|
505
579
|
/**
|
|
506
|
-
*
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
|
|
510
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
511
|
-
/**
|
|
512
|
-
* 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.
|
|
513
|
-
* HTTP POST /user/query
|
|
514
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
515
|
-
*/
|
|
516
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
517
|
-
/**
|
|
518
|
-
* 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.
|
|
519
|
-
* HTTP PUT /user/request-password-reset
|
|
520
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
521
|
-
*/
|
|
522
|
-
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
523
|
-
/**
|
|
524
|
-
* 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.
|
|
525
|
-
* HTTP PUT /user/reset-password
|
|
526
|
-
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
527
|
-
*/
|
|
528
|
-
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
529
|
-
/**
|
|
530
|
-
* 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.
|
|
531
|
-
* HTTP PUT /user/update
|
|
532
|
-
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
533
|
-
*/
|
|
534
|
-
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
535
|
-
/**
|
|
536
|
-
* Returns the identity-provider record corresponding to the current access token. The target realm must be active unless the caller is a superuser.
|
|
537
|
-
* HTTP GET /user/user
|
|
538
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
580
|
+
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
581
|
+
* Response code 417 - The gateway could not establish the requested tunnel
|
|
582
|
+
* HTTP POST /gateway/tunnel
|
|
583
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
539
584
|
*/
|
|
540
|
-
|
|
585
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
541
586
|
/**
|
|
542
|
-
*
|
|
543
|
-
* HTTP
|
|
544
|
-
* Java method: org.openremote.model.
|
|
587
|
+
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
588
|
+
* HTTP DELETE /gateway/tunnel
|
|
589
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
545
590
|
*/
|
|
546
|
-
|
|
591
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
547
592
|
/**
|
|
548
|
-
* Returns
|
|
549
|
-
* HTTP GET /
|
|
550
|
-
* Java method: org.openremote.model.
|
|
593
|
+
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
594
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
595
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
551
596
|
*/
|
|
552
|
-
|
|
597
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
553
598
|
/**
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
* Response code 405 - A non-superuser cannot access the session owner's realm
|
|
558
|
-
* HTTP DELETE /user/{realm}/disconnect/{sessionID}
|
|
559
|
-
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
599
|
+
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
600
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
601
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
560
602
|
*/
|
|
561
|
-
|
|
603
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
562
604
|
/**
|
|
563
|
-
*
|
|
564
|
-
* Response code
|
|
565
|
-
* HTTP
|
|
566
|
-
* Java method: org.openremote.model.
|
|
605
|
+
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
606
|
+
* Response code 204 - No active tunnel matches the requested endpoint
|
|
607
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
608
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
567
609
|
*/
|
|
568
|
-
|
|
610
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
611
|
+
}
|
|
612
|
+
export declare class GatewayClientResourceClient<O> {
|
|
613
|
+
protected httpClient: HttpClient<O>;
|
|
614
|
+
constructor(httpClient: HttpClient<O>);
|
|
569
615
|
/**
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
616
|
+
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
617
|
+
* HTTP DELETE /gateway/connection
|
|
618
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
574
619
|
*/
|
|
575
|
-
|
|
620
|
+
deleteConnections(queryParams?: {
|
|
621
|
+
realm?: string[];
|
|
622
|
+
}, options?: O): RestResponse<void>;
|
|
576
623
|
/**
|
|
577
|
-
*
|
|
578
|
-
* HTTP GET /
|
|
579
|
-
* Java method: org.openremote.model.
|
|
624
|
+
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
625
|
+
* HTTP GET /gateway/connection
|
|
626
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
580
627
|
*/
|
|
581
|
-
|
|
628
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
582
629
|
/**
|
|
583
|
-
*
|
|
584
|
-
* HTTP
|
|
585
|
-
* Java method: org.openremote.model.
|
|
630
|
+
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
631
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
632
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
586
633
|
*/
|
|
587
|
-
|
|
634
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
588
635
|
/**
|
|
589
|
-
* Returns
|
|
590
|
-
*
|
|
591
|
-
*
|
|
636
|
+
* 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.
|
|
637
|
+
* Response code 204 - No gateway connection is configured for the realm
|
|
638
|
+
* HTTP GET /gateway/connection/{realm}
|
|
639
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
592
640
|
*/
|
|
593
|
-
|
|
641
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
594
642
|
/**
|
|
595
|
-
*
|
|
596
|
-
* HTTP PUT /
|
|
597
|
-
* Java method: org.openremote.model.
|
|
643
|
+
* 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.
|
|
644
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
645
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
598
646
|
*/
|
|
599
|
-
|
|
647
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
600
648
|
/**
|
|
601
|
-
* Returns
|
|
602
|
-
* HTTP GET /
|
|
603
|
-
* Java method: org.openremote.model.
|
|
649
|
+
* Returns the live connection state for the requested local realm.
|
|
650
|
+
* HTTP GET /gateway/status/{realm}
|
|
651
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
604
652
|
*/
|
|
605
|
-
|
|
653
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
654
|
+
}
|
|
655
|
+
export declare class AlarmResourceClient<O> {
|
|
656
|
+
protected httpClient: HttpClient<O>;
|
|
657
|
+
constructor(httpClient: HttpClient<O>);
|
|
606
658
|
/**
|
|
607
|
-
*
|
|
608
|
-
* HTTP
|
|
609
|
-
* Java method: org.openremote.model.
|
|
659
|
+
* 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.
|
|
660
|
+
* HTTP POST /alarm
|
|
661
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
610
662
|
*/
|
|
611
|
-
|
|
663
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
664
|
+
assetIds?: string[];
|
|
665
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
612
666
|
/**
|
|
613
|
-
* Returns
|
|
614
|
-
* HTTP GET /
|
|
615
|
-
* Java method: org.openremote.model.
|
|
667
|
+
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
668
|
+
* HTTP GET /alarm
|
|
669
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
616
670
|
*/
|
|
617
|
-
|
|
671
|
+
getAlarms(queryParams?: {
|
|
672
|
+
realm?: string;
|
|
673
|
+
status?: Model.AlarmStatus;
|
|
674
|
+
assetId?: string;
|
|
675
|
+
assigneeId?: string;
|
|
676
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
618
677
|
/**
|
|
619
|
-
*
|
|
620
|
-
* HTTP
|
|
621
|
-
* Java method: org.openremote.model.
|
|
678
|
+
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
679
|
+
* HTTP DELETE /alarm
|
|
680
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
622
681
|
*/
|
|
623
|
-
|
|
682
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
624
683
|
/**
|
|
625
|
-
*
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
684
|
+
* Adds links between assets and one existing alarm.
|
|
685
|
+
|
|
686
|
+
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
687
|
+
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
688
|
+
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
689
|
+
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
690
|
+
|
|
691
|
+
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
692
|
+
This operation does not remove existing links from the alarm.
|
|
693
|
+
|
|
694
|
+
* HTTP PUT /alarm/assets
|
|
695
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
629
696
|
*/
|
|
630
|
-
|
|
697
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
631
698
|
/**
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
*
|
|
635
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
699
|
+
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
700
|
+
* HTTP GET /alarm/{alarmId}
|
|
701
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
636
702
|
*/
|
|
637
|
-
|
|
703
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
638
704
|
/**
|
|
639
|
-
*
|
|
640
|
-
* HTTP
|
|
641
|
-
* Java method: org.openremote.model.
|
|
705
|
+
* Permanently removes one alarm after verifying access to its realm.
|
|
706
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
707
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
642
708
|
*/
|
|
643
|
-
|
|
709
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
644
710
|
/**
|
|
645
|
-
*
|
|
646
|
-
* HTTP PUT /
|
|
647
|
-
* Java method: org.openremote.model.
|
|
711
|
+
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
712
|
+
* HTTP PUT /alarm/{alarmId}
|
|
713
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
648
714
|
*/
|
|
649
|
-
|
|
715
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
650
716
|
/**
|
|
651
|
-
* Returns
|
|
652
|
-
* HTTP GET /
|
|
653
|
-
* Java method: org.openremote.model.
|
|
717
|
+
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
718
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
719
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
654
720
|
*/
|
|
655
|
-
|
|
721
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
722
|
+
realm?: string;
|
|
723
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
656
724
|
}
|
|
657
|
-
export declare class
|
|
725
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
658
726
|
protected httpClient: HttpClient<O>;
|
|
659
727
|
constructor(httpClient: HttpClient<O>);
|
|
660
728
|
/**
|
|
661
|
-
*
|
|
662
|
-
*
|
|
663
|
-
*
|
|
664
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
665
|
-
*/
|
|
666
|
-
getDatapointExport(queryParams?: {
|
|
667
|
-
attributeRefs?: string;
|
|
668
|
-
fromTimestamp?: number;
|
|
669
|
-
toTimestamp?: number;
|
|
670
|
-
format?: Model.DatapointExportFormat;
|
|
671
|
-
}, options?: O): RestResponse<any>;
|
|
672
|
-
/**
|
|
673
|
-
* 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.
|
|
674
|
-
* HTTP GET /asset/datapoint/periods
|
|
675
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
729
|
+
* 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.
|
|
730
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
731
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
676
732
|
*/
|
|
677
|
-
|
|
678
|
-
assetId?: string;
|
|
679
|
-
attributeName?: string;
|
|
680
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
733
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
681
734
|
/**
|
|
682
|
-
*
|
|
683
|
-
* HTTP
|
|
684
|
-
* Java method: org.openremote.model.datapoint.
|
|
735
|
+
* 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.
|
|
736
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
737
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
685
738
|
*/
|
|
686
|
-
|
|
739
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
687
740
|
}
|
|
688
|
-
export declare class
|
|
741
|
+
export declare class SyslogResourceClient<O> {
|
|
689
742
|
protected httpClient: HttpClient<O>;
|
|
690
743
|
constructor(httpClient: HttpClient<O>);
|
|
691
744
|
/**
|
|
692
|
-
* Returns the
|
|
693
|
-
* HTTP GET /
|
|
694
|
-
* Java method: org.openremote.model.
|
|
745
|
+
* Returns the current log-storage and retention configuration. This operation is restricted to a super administrator.
|
|
746
|
+
* HTTP GET /syslog/config
|
|
747
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
695
748
|
*/
|
|
696
|
-
|
|
749
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
697
750
|
/**
|
|
698
|
-
*
|
|
699
|
-
* HTTP
|
|
700
|
-
* Java method: org.openremote.model.
|
|
751
|
+
* Validates and applies log-storage and retention settings. This operation is restricted to a super administrator.
|
|
752
|
+
* HTTP PUT /syslog/config
|
|
753
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
701
754
|
*/
|
|
702
|
-
|
|
755
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
703
756
|
/**
|
|
704
|
-
*
|
|
705
|
-
* HTTP
|
|
706
|
-
* Java method: org.openremote.model.
|
|
757
|
+
* Permanently removes all events from the configured syslog storage. This operation is restricted to a super administrator.
|
|
758
|
+
* HTTP DELETE /syslog/event
|
|
759
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
707
760
|
*/
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
761
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
762
|
+
/**
|
|
763
|
+
* 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.
|
|
764
|
+
* Response code 200 - The requested page of syslog events
|
|
765
|
+
* HTTP GET /syslog/event
|
|
766
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
767
|
+
*/
|
|
768
|
+
getEvents(queryParams?: {
|
|
769
|
+
level?: Model.SyslogLevel;
|
|
770
|
+
per_page?: number;
|
|
771
|
+
page?: number;
|
|
772
|
+
from?: number;
|
|
773
|
+
to?: number;
|
|
774
|
+
category?: Model.SyslogCategory[];
|
|
775
|
+
subCategory?: string[];
|
|
776
|
+
}, options?: O): RestResponse<any>;
|
|
711
777
|
}
|
|
712
|
-
export declare class
|
|
778
|
+
export declare class DashboardResourceClient<O> {
|
|
713
779
|
protected httpClient: HttpClient<O>;
|
|
714
780
|
constructor(httpClient: HttpClient<O>);
|
|
715
781
|
/**
|
|
716
|
-
*
|
|
717
|
-
*
|
|
718
|
-
*
|
|
719
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
720
|
-
*/
|
|
721
|
-
getServices(queryParams?: {
|
|
722
|
-
realm?: string;
|
|
723
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
724
|
-
/**
|
|
725
|
-
* 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.
|
|
726
|
-
* Response code 200 - Service registered successfully
|
|
727
|
-
* Response code 400 - Invalid external service object
|
|
728
|
-
* Response code 409 - ExternalService instance already registered
|
|
729
|
-
* HTTP POST /service
|
|
730
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
782
|
+
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
783
|
+
* HTTP POST /dashboard
|
|
784
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
731
785
|
*/
|
|
732
|
-
|
|
786
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
733
787
|
/**
|
|
734
|
-
*
|
|
735
|
-
*
|
|
736
|
-
*
|
|
737
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
788
|
+
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
789
|
+
* HTTP PUT /dashboard
|
|
790
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
738
791
|
*/
|
|
739
|
-
|
|
792
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
740
793
|
/**
|
|
741
|
-
*
|
|
742
|
-
*
|
|
743
|
-
*
|
|
744
|
-
* Response code 409 - ExternalService instance already registered
|
|
745
|
-
* HTTP POST /service/global
|
|
746
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
794
|
+
* 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.
|
|
795
|
+
* HTTP GET /dashboard/all/{realm}
|
|
796
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
747
797
|
*/
|
|
748
|
-
|
|
798
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
749
799
|
/**
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
754
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
800
|
+
* 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.
|
|
801
|
+
* HTTP POST /dashboard/query
|
|
802
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
755
803
|
*/
|
|
756
|
-
|
|
804
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
757
805
|
/**
|
|
758
|
-
*
|
|
759
|
-
*
|
|
760
|
-
*
|
|
761
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
762
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
806
|
+
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
807
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
808
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
763
809
|
*/
|
|
764
|
-
|
|
810
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
765
811
|
/**
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
770
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
812
|
+
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
813
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
814
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
771
815
|
*/
|
|
772
|
-
|
|
816
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
773
817
|
}
|
|
774
|
-
export declare class
|
|
818
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
775
819
|
protected httpClient: HttpClient<O>;
|
|
776
820
|
constructor(httpClient: HttpClient<O>);
|
|
777
821
|
/**
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
*
|
|
822
|
+
* 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.
|
|
823
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
824
|
+
* HTTP GET /asset/datapoint/export
|
|
825
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
781
826
|
*/
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
827
|
+
getDatapointExport(queryParams?: {
|
|
828
|
+
attributeRefs?: string;
|
|
829
|
+
fromTimestamp?: number;
|
|
830
|
+
toTimestamp?: number;
|
|
831
|
+
format?: Model.DatapointExportFormat;
|
|
832
|
+
}, options?: O): RestResponse<any>;
|
|
785
833
|
/**
|
|
786
|
-
* Returns
|
|
787
|
-
* HTTP GET /
|
|
788
|
-
* Java method: org.openremote.model.
|
|
834
|
+
* 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.
|
|
835
|
+
* HTTP GET /asset/datapoint/periods
|
|
836
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
789
837
|
*/
|
|
790
|
-
|
|
791
|
-
realm?: string;
|
|
792
|
-
status?: Model.AlarmStatus;
|
|
838
|
+
getDatapointPeriod(queryParams?: {
|
|
793
839
|
assetId?: string;
|
|
794
|
-
|
|
795
|
-
}, options?: O): RestResponse<Model.
|
|
796
|
-
/**
|
|
797
|
-
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
798
|
-
* HTTP DELETE /alarm
|
|
799
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
800
|
-
*/
|
|
801
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
840
|
+
attributeName?: string;
|
|
841
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
802
842
|
/**
|
|
803
|
-
*
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
807
|
-
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
808
|
-
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
809
|
-
|
|
810
|
-
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
811
|
-
This operation does not remove existing links from the alarm.
|
|
812
|
-
|
|
813
|
-
* HTTP PUT /alarm/assets
|
|
814
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
843
|
+
* 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.
|
|
844
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
845
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
815
846
|
*/
|
|
816
|
-
|
|
847
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
848
|
+
}
|
|
849
|
+
export declare class FlowResourceClient<O> {
|
|
850
|
+
protected httpClient: HttpClient<O>;
|
|
851
|
+
constructor(httpClient: HttpClient<O>);
|
|
817
852
|
/**
|
|
818
|
-
* Returns
|
|
819
|
-
* HTTP GET /
|
|
820
|
-
* Java method: org.openremote.model.
|
|
853
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
854
|
+
* HTTP GET /flow
|
|
855
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
821
856
|
*/
|
|
822
|
-
|
|
857
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
823
858
|
/**
|
|
824
|
-
*
|
|
825
|
-
* HTTP
|
|
826
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* Resolves one flow node definition by its model name.
|
|
860
|
+
* HTTP GET /flow/{name}
|
|
861
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
827
862
|
*/
|
|
828
|
-
|
|
863
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
829
864
|
/**
|
|
830
|
-
*
|
|
831
|
-
* HTTP
|
|
832
|
-
* Java method: org.openremote.model.
|
|
865
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
866
|
+
* HTTP GET /flow/{type}
|
|
867
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
833
868
|
*/
|
|
834
|
-
|
|
869
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
870
|
+
}
|
|
871
|
+
export declare class ConsoleResourceClient<O> {
|
|
872
|
+
protected httpClient: HttpClient<O>;
|
|
873
|
+
constructor(httpClient: HttpClient<O>);
|
|
835
874
|
/**
|
|
836
|
-
*
|
|
837
|
-
* HTTP
|
|
838
|
-
* Java method: org.openremote.model.
|
|
875
|
+
* 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.
|
|
876
|
+
* HTTP POST /console/register
|
|
877
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
839
878
|
*/
|
|
840
|
-
|
|
841
|
-
realm?: string;
|
|
842
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
879
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
843
880
|
}
|
|
844
881
|
export declare class AssetModelResourceClient<O> {
|
|
845
882
|
protected httpClient: HttpClient<O>;
|
|
@@ -902,201 +939,184 @@ export declare class AssetModelResourceClient<O> {
|
|
|
902
939
|
[index: string]: Model.ValueDescriptor;
|
|
903
940
|
}>;
|
|
904
941
|
}
|
|
905
|
-
export declare class
|
|
942
|
+
export declare class AppResourceClient<O> {
|
|
906
943
|
protected httpClient: HttpClient<O>;
|
|
907
944
|
constructor(httpClient: HttpClient<O>);
|
|
908
945
|
/**
|
|
909
|
-
*
|
|
910
|
-
* HTTP
|
|
911
|
-
* Java method: org.openremote.model.
|
|
946
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
947
|
+
* HTTP GET /apps
|
|
948
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
912
949
|
*/
|
|
913
|
-
|
|
950
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
951
|
+
/**
|
|
952
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
953
|
+
* HTTP GET /apps/consoleConfig
|
|
954
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
955
|
+
*/
|
|
956
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
957
|
+
/**
|
|
958
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
959
|
+
* HTTP GET /apps/info
|
|
960
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
961
|
+
*/
|
|
962
|
+
getAppInfos(options?: O): RestResponse<{
|
|
963
|
+
[index: string]: any;
|
|
964
|
+
}>;
|
|
914
965
|
}
|
|
915
|
-
export declare class
|
|
966
|
+
export declare class UserResourceClient<O> {
|
|
916
967
|
protected httpClient: HttpClient<O>;
|
|
917
968
|
constructor(httpClient: HttpClient<O>);
|
|
918
969
|
/**
|
|
919
|
-
*
|
|
920
|
-
* HTTP
|
|
921
|
-
* Java method: org.openremote.model.
|
|
922
|
-
*/
|
|
923
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
924
|
-
/**
|
|
925
|
-
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
926
|
-
* HTTP GET /provisioning
|
|
927
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
970
|
+
* 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.
|
|
971
|
+
* HTTP PUT /user/locale
|
|
972
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
928
973
|
*/
|
|
929
|
-
|
|
974
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
930
975
|
/**
|
|
931
|
-
*
|
|
932
|
-
* HTTP
|
|
933
|
-
* Java method: org.openremote.model.
|
|
976
|
+
* 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.
|
|
977
|
+
* HTTP POST /user/query
|
|
978
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
934
979
|
*/
|
|
935
|
-
|
|
980
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
936
981
|
/**
|
|
937
|
-
*
|
|
938
|
-
* HTTP PUT /
|
|
939
|
-
* Java method: org.openremote.model.
|
|
982
|
+
* 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.
|
|
983
|
+
* HTTP PUT /user/request-password-reset
|
|
984
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
940
985
|
*/
|
|
941
|
-
|
|
942
|
-
}
|
|
943
|
-
export declare class GatewayClientResourceClient<O> {
|
|
944
|
-
protected httpClient: HttpClient<O>;
|
|
945
|
-
constructor(httpClient: HttpClient<O>);
|
|
986
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
946
987
|
/**
|
|
947
|
-
*
|
|
948
|
-
* HTTP
|
|
949
|
-
* Java method: org.openremote.model.
|
|
988
|
+
* 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.
|
|
989
|
+
* HTTP PUT /user/reset-password
|
|
990
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
950
991
|
*/
|
|
951
|
-
|
|
952
|
-
realm?: string[];
|
|
953
|
-
}, options?: O): RestResponse<void>;
|
|
992
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
954
993
|
/**
|
|
955
|
-
*
|
|
956
|
-
* HTTP
|
|
957
|
-
* Java method: org.openremote.model.
|
|
994
|
+
* 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.
|
|
995
|
+
* HTTP PUT /user/update
|
|
996
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
958
997
|
*/
|
|
959
|
-
|
|
998
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
960
999
|
/**
|
|
961
|
-
*
|
|
962
|
-
* HTTP
|
|
963
|
-
* Java method: org.openremote.model.
|
|
1000
|
+
* Returns the identity-provider record corresponding to the current access token. The target realm must be active unless the caller is a superuser.
|
|
1001
|
+
* HTTP GET /user/user
|
|
1002
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
964
1003
|
*/
|
|
965
|
-
|
|
1004
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
966
1005
|
/**
|
|
967
|
-
* Returns
|
|
968
|
-
*
|
|
969
|
-
*
|
|
970
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
1006
|
+
* Returns realm-level role names assigned to the caller. The target realm must be active unless the caller is a superuser.
|
|
1007
|
+
* HTTP GET /user/userRealmRoles
|
|
1008
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
971
1009
|
*/
|
|
972
|
-
|
|
1010
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
973
1011
|
/**
|
|
974
|
-
*
|
|
975
|
-
* HTTP
|
|
976
|
-
* Java method: org.openremote.model.
|
|
1012
|
+
* 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.
|
|
1013
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
1014
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
977
1015
|
*/
|
|
978
|
-
|
|
1016
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
979
1017
|
/**
|
|
980
|
-
*
|
|
981
|
-
*
|
|
982
|
-
*
|
|
1018
|
+
* 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.
|
|
1019
|
+
* 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
|
|
1020
|
+
* Response code 404 - The session or its owning user does not exist, or the session does not belong to the specified realm
|
|
1021
|
+
* Response code 405 - A non-superuser cannot access the session owner's realm
|
|
1022
|
+
* HTTP DELETE /user/{realm}/disconnect/{sessionID}
|
|
1023
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
983
1024
|
*/
|
|
984
|
-
|
|
985
|
-
}
|
|
986
|
-
export declare class SyslogResourceClient<O> {
|
|
987
|
-
protected httpClient: HttpClient<O>;
|
|
988
|
-
constructor(httpClient: HttpClient<O>);
|
|
1025
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
989
1026
|
/**
|
|
990
|
-
*
|
|
991
|
-
*
|
|
992
|
-
*
|
|
1027
|
+
* 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.
|
|
1028
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
1029
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
1030
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
993
1031
|
*/
|
|
994
|
-
|
|
1032
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
995
1033
|
/**
|
|
996
|
-
*
|
|
997
|
-
*
|
|
998
|
-
*
|
|
1034
|
+
* 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.
|
|
1035
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
1036
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
1037
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
999
1038
|
*/
|
|
1000
|
-
|
|
1039
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
1001
1040
|
/**
|
|
1002
|
-
*
|
|
1003
|
-
* HTTP
|
|
1004
|
-
* Java method: org.openremote.model.
|
|
1041
|
+
* 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.
|
|
1042
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
1043
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
1005
1044
|
*/
|
|
1006
|
-
|
|
1045
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
1007
1046
|
/**
|
|
1008
|
-
*
|
|
1009
|
-
*
|
|
1010
|
-
*
|
|
1011
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
1047
|
+
* 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.
|
|
1048
|
+
* HTTP PUT /user/{realm}/roles
|
|
1049
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
1012
1050
|
*/
|
|
1013
|
-
|
|
1014
|
-
level?: Model.SyslogLevel;
|
|
1015
|
-
per_page?: number;
|
|
1016
|
-
page?: number;
|
|
1017
|
-
from?: number;
|
|
1018
|
-
to?: number;
|
|
1019
|
-
category?: Model.SyslogCategory[];
|
|
1020
|
-
subCategory?: string[];
|
|
1021
|
-
}, options?: O): RestResponse<any>;
|
|
1022
|
-
}
|
|
1023
|
-
export declare class FlowResourceClient<O> {
|
|
1024
|
-
protected httpClient: HttpClient<O>;
|
|
1025
|
-
constructor(httpClient: HttpClient<O>);
|
|
1051
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
1026
1052
|
/**
|
|
1027
|
-
* Returns
|
|
1028
|
-
* HTTP GET /
|
|
1029
|
-
* Java method: org.openremote.model.
|
|
1053
|
+
* 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.
|
|
1054
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
1055
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
1030
1056
|
*/
|
|
1031
|
-
|
|
1057
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
1032
1058
|
/**
|
|
1033
|
-
*
|
|
1034
|
-
* HTTP
|
|
1035
|
-
* Java method: org.openremote.model.
|
|
1059
|
+
* 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.
|
|
1060
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
1061
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
1036
1062
|
*/
|
|
1037
|
-
|
|
1063
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
1038
1064
|
/**
|
|
1039
|
-
* Returns
|
|
1040
|
-
* HTTP GET /
|
|
1041
|
-
* Java method: org.openremote.model.
|
|
1065
|
+
* 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.
|
|
1066
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
1067
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
1042
1068
|
*/
|
|
1043
|
-
|
|
1044
|
-
}
|
|
1045
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
1046
|
-
protected httpClient: HttpClient<O>;
|
|
1047
|
-
constructor(httpClient: HttpClient<O>);
|
|
1069
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
1048
1070
|
/**
|
|
1049
|
-
*
|
|
1050
|
-
* HTTP
|
|
1051
|
-
* Java method: org.openremote.model.
|
|
1071
|
+
* 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.
|
|
1072
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
1073
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
1052
1074
|
*/
|
|
1053
|
-
|
|
1075
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
1054
1076
|
/**
|
|
1055
|
-
*
|
|
1056
|
-
* HTTP
|
|
1057
|
-
* Java method: org.openremote.model.
|
|
1077
|
+
* 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.
|
|
1078
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
1079
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
1058
1080
|
*/
|
|
1059
|
-
|
|
1060
|
-
}
|
|
1061
|
-
export declare class DashboardResourceClient<O> {
|
|
1062
|
-
protected httpClient: HttpClient<O>;
|
|
1063
|
-
constructor(httpClient: HttpClient<O>);
|
|
1081
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
1064
1082
|
/**
|
|
1065
|
-
* Creates
|
|
1066
|
-
* HTTP POST /
|
|
1067
|
-
* Java method: org.openremote.model.
|
|
1083
|
+
* 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.
|
|
1084
|
+
* HTTP POST /user/{realm}/users
|
|
1085
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
1068
1086
|
*/
|
|
1069
|
-
create(
|
|
1087
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
1070
1088
|
/**
|
|
1071
|
-
* Updates an existing
|
|
1072
|
-
*
|
|
1073
|
-
*
|
|
1089
|
+
* 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.
|
|
1090
|
+
* Response code 405 - The requested cross-realm or protected master-administrator mutation is not allowed
|
|
1091
|
+
* HTTP PUT /user/{realm}/users
|
|
1092
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
1074
1093
|
*/
|
|
1075
|
-
update(
|
|
1094
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
1076
1095
|
/**
|
|
1077
|
-
*
|
|
1078
|
-
*
|
|
1079
|
-
*
|
|
1096
|
+
* 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.
|
|
1097
|
+
* Response code 405 - The master-realm administrator cannot be deleted
|
|
1098
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
1099
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
1080
1100
|
*/
|
|
1081
|
-
|
|
1101
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
1082
1102
|
/**
|
|
1083
|
-
*
|
|
1084
|
-
* HTTP
|
|
1085
|
-
* Java method: org.openremote.model.
|
|
1103
|
+
* 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.
|
|
1104
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
1105
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
1086
1106
|
*/
|
|
1087
|
-
|
|
1107
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
1088
1108
|
/**
|
|
1089
|
-
*
|
|
1090
|
-
* HTTP
|
|
1091
|
-
* Java method: org.openremote.model.
|
|
1109
|
+
* Creates, updates, or removes role definitions for a named identity-provider client. The target realm must be active unless the caller is a superuser.
|
|
1110
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
1111
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
1092
1112
|
*/
|
|
1093
|
-
|
|
1113
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
1094
1114
|
/**
|
|
1095
|
-
* Returns one
|
|
1096
|
-
* HTTP GET /
|
|
1097
|
-
* Java method: org.openremote.model.
|
|
1115
|
+
* 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.
|
|
1116
|
+
* HTTP GET /user/{realm}/{userId}
|
|
1117
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
1098
1118
|
*/
|
|
1099
|
-
get(realm: string,
|
|
1119
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
1100
1120
|
}
|
|
1101
1121
|
export declare class MapResourceClient<O> {
|
|
1102
1122
|
protected httpClient: HttpClient<O>;
|
|
@@ -1152,73 +1172,53 @@ export declare class MapResourceClient<O> {
|
|
|
1152
1172
|
[id: string]: unknown;
|
|
1153
1173
|
}>;
|
|
1154
1174
|
}
|
|
1155
|
-
export declare class StatusResourceClient<O> {
|
|
1156
|
-
protected httpClient: HttpClient<O>;
|
|
1157
|
-
constructor(httpClient: HttpClient<O>);
|
|
1158
|
-
/**
|
|
1159
|
-
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
1160
|
-
* HTTP GET /health
|
|
1161
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
1162
|
-
*/
|
|
1163
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
1164
|
-
[index: string]: any;
|
|
1165
|
-
}>;
|
|
1166
|
-
/**
|
|
1167
|
-
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
1168
|
-
* HTTP GET /info
|
|
1169
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
1170
|
-
*/
|
|
1171
|
-
getInfo(options?: O): RestResponse<{
|
|
1172
|
-
[index: string]: any;
|
|
1173
|
-
}>;
|
|
1174
|
-
}
|
|
1175
1175
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1176
1176
|
export declare class ApiClient {
|
|
1177
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
1178
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
1179
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1177
1180
|
protected _realmResource: AxiosRealmResourceClient;
|
|
1178
1181
|
protected _agentResource: AxiosAgentResourceClient;
|
|
1179
|
-
protected
|
|
1182
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1180
1183
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1181
|
-
protected
|
|
1182
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
1184
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1183
1185
|
protected _assetResource: AxiosAssetResourceClient;
|
|
1184
|
-
protected
|
|
1185
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1186
|
-
protected _appResource: AxiosAppResourceClient;
|
|
1187
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1188
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1189
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1190
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1191
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1186
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1192
1187
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1193
|
-
protected
|
|
1194
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
1188
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1195
1189
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1190
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1196
1191
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1192
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1193
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1194
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1195
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1196
|
+
protected _appResource: AxiosAppResourceClient;
|
|
1197
|
+
protected _userResource: AxiosUserResourceClient;
|
|
1197
1198
|
protected _mapResource: AxiosMapResourceClient;
|
|
1198
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
1199
1199
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1200
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1201
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1202
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1200
1203
|
get RealmResource(): AxiosRealmResourceClient;
|
|
1201
1204
|
get AgentResource(): AxiosAgentResourceClient;
|
|
1202
|
-
get
|
|
1205
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1203
1206
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1204
|
-
get
|
|
1205
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1207
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1206
1208
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1207
|
-
get
|
|
1208
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1209
|
-
get AppResource(): AxiosAppResourceClient;
|
|
1210
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1211
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1212
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1213
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1214
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1209
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1215
1210
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1216
|
-
get
|
|
1217
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1211
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1218
1212
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1213
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1219
1214
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1215
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1216
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1217
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1218
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1219
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1220
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1220
1221
|
get MapResource(): AxiosMapResourceClient;
|
|
1221
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1222
1222
|
}
|
|
1223
1223
|
import * as Axios from "axios";
|
|
1224
1224
|
declare module "axios" {
|
|
@@ -1226,70 +1226,70 @@ declare module "axios" {
|
|
|
1226
1226
|
data: R;
|
|
1227
1227
|
}
|
|
1228
1228
|
}
|
|
1229
|
-
export declare class
|
|
1229
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1230
1230
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1231
1231
|
}
|
|
1232
|
-
export declare class
|
|
1232
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1233
1233
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1234
1234
|
}
|
|
1235
|
-
export declare class
|
|
1235
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1236
1236
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1237
1237
|
}
|
|
1238
|
-
export declare class
|
|
1238
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1239
1239
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1240
1240
|
}
|
|
1241
|
-
export declare class
|
|
1241
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1242
1242
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1243
1243
|
}
|
|
1244
|
-
export declare class
|
|
1244
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1245
1245
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1246
1246
|
}
|
|
1247
|
-
export declare class
|
|
1247
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1248
1248
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1249
1249
|
}
|
|
1250
|
-
export declare class
|
|
1250
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1251
1251
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1252
1252
|
}
|
|
1253
|
-
export declare class
|
|
1253
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1254
1254
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1255
1255
|
}
|
|
1256
|
-
export declare class
|
|
1256
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1257
1257
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1258
1258
|
}
|
|
1259
|
-
export declare class
|
|
1259
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1260
1260
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1261
1261
|
}
|
|
1262
1262
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1263
1263
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1264
1264
|
}
|
|
1265
|
-
export declare class
|
|
1265
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1266
1266
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1267
1267
|
}
|
|
1268
|
-
export declare class
|
|
1268
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1269
1269
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1270
1270
|
}
|
|
1271
|
-
export declare class
|
|
1271
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1272
1272
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1273
1273
|
}
|
|
1274
|
-
export declare class
|
|
1274
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1275
1275
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1276
1276
|
}
|
|
1277
|
-
export declare class
|
|
1277
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1278
1278
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1279
1279
|
}
|
|
1280
|
-
export declare class
|
|
1280
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1281
1281
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1282
1282
|
}
|
|
1283
|
-
export declare class
|
|
1283
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1284
1284
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1285
1285
|
}
|
|
1286
|
-
export declare class
|
|
1286
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1287
1287
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1288
1288
|
}
|
|
1289
|
-
export declare class
|
|
1289
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1290
1290
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1291
1291
|
}
|
|
1292
|
-
export declare class
|
|
1292
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1293
1293
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1294
1294
|
}
|
|
1295
1295
|
//# sourceMappingURL=restclient.d.ts.map
|