ESPRMAdminDashboard
Defined in: src/ESPRMAdminDashboard.ts:11
Shell class for admin dashboard operations. Methods are added via prototype augmentation in methods/ESPRMAdminDashboard/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminDashboard():
ESPRMAdminDashboard
Returns
Section titled “Returns”ESPRMAdminDashboard
Methods
Section titled “Methods”getDashboardUpdateStatus()
Section titled “getDashboardUpdateStatus()”getDashboardUpdateStatus():
Promise<GetDashboardUpdateStatusResponse>
Defined in: src/methods/ESPRMAdminDashboard/GetDashboardUpdateStatus.ts:20
Retrieves the current status of a dashboard update operation.
Returns
Section titled “Returns”Promise<GetDashboardUpdateStatusResponse>
The dashboard update status response.
getDashboardVersionMapping()
Section titled “getDashboardVersionMapping()”getDashboardVersionMapping():
Promise<GetDashboardVersionMappingResponse>
Defined in: src/methods/ESPRMAdminDashboard/GetDashboardVersionMapping.ts:20
Retrieves the version mapping for the dashboard, showing available versions and their associations.
Returns
Section titled “Returns”Promise<GetDashboardVersionMappingResponse>
The dashboard version mapping response.
updateDashboard()
Section titled “updateDashboard()”updateDashboard(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminDashboard/UpdateDashboard.ts:22
Triggers a dashboard update with the specified parameters.
Parameters
Section titled “Parameters”params
Section titled “params”The dashboard update request parameters.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon initiating the dashboard update.