ESPRMAdminConfiguration
Defined in: src/ESPRMAdminConfiguration.ts:11
Shell class for admin configuration operations. Methods are added via prototype augmentation in methods/ESPRMAdminConfiguration/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminConfiguration():
ESPRMAdminConfiguration
Returns
Section titled “Returns”ESPRMAdminConfiguration
Methods
Section titled “Methods”getNotifications()
Section titled “getNotifications()”getNotifications(
params?):Promise<GetNotificationsResponse>
Defined in: src/methods/ESPRMAdminConfiguration/GetNotifications.ts:22
Retrieves notification configurations, optionally filtered by the provided parameters.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filtering parameters for the notifications query.
Returns
Section titled “Returns”Promise<GetNotificationsResponse>
The notification configuration data.
updateNotifications()
Section titled “updateNotifications()”updateNotifications(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminConfiguration/UpdateNotifications.ts:22
Updates the notification configuration with the provided settings.
Parameters
Section titled “Parameters”params
Section titled “params”The notification settings to update.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon updating the notifications.