Skip to main content

Class: EventActionConfigService

Defined in: service/EventActionConfigService.ts:119

Backwards-compatible class form. New code should call eventActionConfigService(client).

Constructors​

Constructor​

new EventActionConfigService(client): EventActionConfigService

Defined in: service/EventActionConfigService.ts:121

Parameters​

client​

GraphQLClient

Returns​

EventActionConfigService

Methods​

createEventToEmailConfig()​

createEventToEmailConfig(input): Promise<EventToEmailConfig>

Defined in: service/EventActionConfigService.ts:136

Creates a new event to email configuration

Parameters​

input​

EventToEmailConfigCreateInput

EventToEmailConfig creation input data

Returns​

Promise<EventToEmailConfig>

createEventToWebHookConfig()​

createEventToWebHookConfig(input): Promise<EventToWebHookConfig>

Defined in: service/EventActionConfigService.ts:146

Creates a new event to webhook configuration

Parameters​

input​

EventToWebHookConfigCreateInput

EventToWebHookConfig creation input data

Returns​

Promise<EventToWebHookConfig>

getEventActionConfig()​

getEventActionConfig(id): Promise<IEventActionConfig>

Defined in: service/EventActionConfigService.ts:126

Retrieves a specific event action configuration

Parameters​

id​

number

Event action config ID

Returns​

Promise<IEventActionConfig>

getEventActionConfigs()​

getEventActionConfigs(input?): Promise<EventActionConfigResponse>

Defined in: service/EventActionConfigService.ts:131

Retrieves event action configurations with optional search

Parameters​

input?​

EventActionConfigSearchInput

Search input parameters

Returns​

Promise<EventActionConfigResponse>

publishEmailEvent()​

publishEmailEvent(input): Promise<PublishEmailEventResponse>

Defined in: service/EventActionConfigService.ts:156

Publishes an email event

Parameters​

input​

EmailEventInput

Email event input data

Returns​

Promise<PublishEmailEventResponse>

publishEmailSendEvent()​

publishEmailSendEvent(input): Promise<PublishEmailEventResponse>

Defined in: service/EventActionConfigService.ts:161

Publishes an email send event

Parameters​

input​

EmailSendEventInput

Email send event input data

Returns​

Promise<PublishEmailEventResponse>

publishPasswordResetEmailEvent()​

publishPasswordResetEmailEvent(input): Promise<PublishEmailEventResponse>

Defined in: service/EventActionConfigService.ts:166

Publishes a password reset email event

Parameters​

input​

PasswordResetLinkEmailInput

Password reset email event input data

Returns​

Promise<PublishEmailEventResponse>

updateEventToEmailConfig()​

updateEventToEmailConfig(variables): Promise<EventToEmailConfig>

Defined in: service/EventActionConfigService.ts:141

Updates an existing event to email configuration

Parameters​

variables​

EventToEmailConfigUpdateVariables

EventToEmailConfig update input data

Returns​

Promise<EventToEmailConfig>

updateEventToWebHookConfig()​

updateEventToWebHookConfig(variables): Promise<EventToWebHookConfig>

Defined in: service/EventActionConfigService.ts:151

Updates an existing event to webhook configuration

Parameters​

variables​

EventToWebHookConfigUpdateVariables

EventToWebHookConfig update input data

Returns​

Promise<EventToWebHookConfig>