Interface EmailEventsService

interface EmailEventsService {
    findById(
        id: string,
        listQueryOptions?: ListQueryOptions<BaseEmailEvent>,
    ): Promise<null | BaseEmailEvent>;
    findEmailEvents(query: Query<BaseEmailEvent>): Promise<BaseEmailEvent[]>;
    trackEmailEvent(payload: EmailEventPayload): Promise<BaseEmailEvent>;
}

Index

Methods

findById findEmailEvents trackEmailEvent

Methods

findById

findById(
id: string,
listQueryOptions?: ListQueryOptions<BaseEmailEvent>,
): Promise<null | BaseEmailEvent>
Retrieves a EmailEvent by its id
Parameters
- id: string
- OptionallistQueryOptions: ListQueryOptions<BaseEmailEvent>
Returns Promise<null | BaseEmailEvent>
- Defined in packages/services/src/services/EmailEvents/EmailEventsService.ts:13

findEmailEvents

findEmailEvents(query: Query<BaseEmailEvent>): Promise<BaseEmailEvent[]>
Retrieves a list of EmailEvent searching by a given query
Parameters
- query: Query<BaseEmailEvent>
Returns Promise<BaseEmailEvent[]>
- Defined in packages/services/src/services/EmailEvents/EmailEventsService.ts:22

trackEmailEvent

trackEmailEvent(payload: EmailEventPayload): Promise<BaseEmailEvent>
Persists a new EmailEvent instance
Parameters
- payload: EmailEventPayload
Returns Promise<BaseEmailEvent>
- Defined in packages/services/src/services/EmailEvents/EmailEventsService.ts:30