ESPRMAdminEventFilter
Defined in: src/ESPRMAdminEventFilter.ts:11
Shell class for admin event filter management operations. Methods are added via prototype augmentation in methods/ESPRMAdminEventFilter/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminEventFilter():
ESPRMAdminEventFilter
Returns
Section titled “Returns”ESPRMAdminEventFilter
Methods
Section titled “Methods”createEventFilter()
Section titled “createEventFilter()”createEventFilter(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminEventFilter/CreateEventFilter.ts:27
Creates a new event filter for the specified entity and event type.
Parameters
Section titled “Parameters”params
Section titled “params”The event type, entity ID, entity type, and filter configuration.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the event filter was created.
deleteEventFilter()
Section titled “deleteEventFilter()”deleteEventFilter(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminEventFilter/DeleteEventFilter.ts:27
Deletes an event filter identified by event type and entity ID.
Parameters
Section titled “Parameters”params
Section titled “params”The event type and entity ID of the filter to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the event filter was deleted.
getEventFilters()
Section titled “getEventFilters()”getEventFilters(
params?):Promise<GetEventFiltersResponse>
Defined in: src/methods/ESPRMAdminEventFilter/GetEventFilters.ts:22
Retrieves event filters with optional filtering and pagination.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter or paginate results.
Returns
Section titled “Returns”Promise<GetEventFiltersResponse>
The list of event filters matching the query.
updateEventFilter()
Section titled “updateEventFilter()”updateEventFilter(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminEventFilter/UpdateEventFilter.ts:22
Updates an existing event filter configuration.
Parameters
Section titled “Parameters”params
Section titled “params”The updated event filter properties.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the event filter was updated.