Class EmailTemplates

Hierarchy

default
- EmailTemplates

Index

Constructors

constructor

Methods

createEmailTemplate deleteEmailTemplate getEmailTemplate searchEmailTemplates updateEmailTemplate

Constructors

constructor

new EmailTemplates(options: ConstructorOptions): EmailTemplates

Parameters

options: ConstructorOptions

Returns EmailTemplates

Example

import * as OneBlink from '@oneblink/sdk'
  const options = {
    accessKey: '123455678901ABCDEFGHIJKL',
    secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
  }
  const emailTemplates = new OneBlink.EmailTemplates(options)

Methods

createEmailTemplate

createEmailTemplate(data: NewEmailTemplate): Promise<EmailTemplate>

Minimum Role Permission

Email Templates: Manager

Parameters

data: NewEmailTemplate
The data for the new email template

Returns 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...

deleteEmailTemplate

deleteEmailTemplate(id: number): Promise<void>
Minimum Role Permission

Email Templates: Manager
Parameters
- id: number
  The id of the email template to delete
Returns Promise<void>
Example
```
await emailTemplates.deleteEmailTemplate(1)
```

getEmailTemplate

getEmailTemplate(id: number): Promise<EmailTemplate>
Minimum Role Permission

Email Templates: Read Only
Parameters
- id: number
  The id of the email template
Returns Promise<EmailTemplate>
Example
```
const emailTemplate = await emailTemplates.getEmailTemplate(1)
  // Use data here...
```

searchEmailTemplates

searchEmailTemplates(
searchParams: BaseSearchOptions,
): Promise<EmailTemplatesSearchResult>
Minimum Role Permission

Email Templates: Read Only
Parameters
- searchParams: BaseSearchOptions
  Search options
Returns Promise<EmailTemplatesSearchResult>
Example
```
const searchParams = {
    limit: 1,
    offset: 0,
  }
  const { emailTemplates, meta } =
    await emailTemplates.searchEmailTemplates(searchParams)
```

updateEmailTemplate

updateEmailTemplate(data: EmailTemplate): Promise<EmailTemplate>

Minimum Role Permission

Email Templates: Manager

Parameters

data: EmailTemplate
The data for the email template to update

Returns 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...

Class EmailTemplates

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EmailTemplates

Example

Methods

createEmailTemplate

Parameters

Returns Promise<EmailTemplate>

Example

deleteEmailTemplate

Parameters

Returns Promise<void>

Example

getEmailTemplate

Parameters

Returns Promise<EmailTemplate>

Example

searchEmailTemplates

Parameters

Returns Promise<EmailTemplatesSearchResult>

Example

updateEmailTemplate

Parameters

Returns Promise<EmailTemplate>

Example

Settings

On This Page