Class EmailTemplates

Hierarchy

  • default
    • EmailTemplates

Constructors

constructor

Methods

createEmailTemplate deleteEmailTemplate getEmailTemplate searchEmailTemplates updateEmailTemplate

Constructors

constructor

  • new EmailTemplates(options): EmailTemplates

  • Example

    const OneBlink = require('@oneblink/sdk')

    const options = {
      accessKey: '123455678901ABCDEFGHIJKL',
      secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
    }
    const emailTemplates = new OneBlink.EmailTemplates(options)

    Parameters

    Returns EmailTemplates

Methods

createEmailTemplate

  • createEmailTemplate(data): Promise<EmailTemplate>

  • Example

    const data = {
      name: 'my template',
      organisationId: 'abc123',
      environments: [
        {
          template: 'My email template {{custom:my-custom-tag}}',
          formsAppEnvironmentId: 1,
        },
      ],
      type: 'FORM_SUBMISSION_EVENT_PDF',
    }
    const emailTemplate = await emailTemplates.createEmailTemplate(data)
    // Use emailTemplate here...

    Parameters

    Returns Promise<EmailTemplate>

deleteEmailTemplate

  • deleteEmailTemplate(id): Promise<void>

  • Example

    await emailTemplates.deleteEmailTemplate(1)

    Parameters

    • id: number

      The id of the email template to delete

    Returns Promise<void>

getEmailTemplate

  • getEmailTemplate(id): Promise<EmailTemplate>

  • Example

    const emailTemplate = await emailTemplates.getEmailTemplate(1)
    // Use data here...

    Parameters

    • id: number

      The id of the email template

    Returns Promise<EmailTemplate>

searchEmailTemplates

updateEmailTemplate

  • updateEmailTemplate(data): Promise<EmailTemplate>

  • Example

    const data = {
      id: 1,
      name: 'my updated template',
      organisationId: 'abc123',
      environments: [
        {
          template: 'My email template {{custom:my-custom-tag}}',
          formsAppEnvironmentId: 1,
        },
      ],
      type: 'FORM_SUBMISSION_EVENT_PDF',
    }
    const emailTemplate = await emailTemplates.updateEmailTemplate(data)
    // Use emailTemplate here...

    Parameters

    Returns Promise<EmailTemplate>

Settings

Member Visibility

Theme

On This Page