Class MarketingService

Marketing service

Hierarchy

MarketingService

Index

Constructors

Properties

httpClient namespace

Methods

createEmailTemplate deleteEmailTemplate getEmailTemplate getEmailTemplates massDeletionEmailTemplates massEditingEmailTemplates updateEmailTemplate

Constructors

constructor

new MarketingService(httpClient): MarketingService
Parameters
- httpClient: HttpClient
Returns MarketingService

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/marketing/v1/templates'

Methods

createEmailTemplate

createEmailTemplate(data): Promise<AxiosResponse<IEmailTemplate, any>>
Create email template
Parameters
- data: Partial<IEmailTemplate>
  
  email template payload
Returns Promise<AxiosResponse<IEmailTemplate, any>>
Email template entity

deleteEmailTemplate

deleteEmailTemplate(id): Promise<AxiosResponse<any, any>>
Delete email template
Parameters
- id: number
  
  email template id
Returns Promise<AxiosResponse<any, any>>

getEmailTemplate

getEmailTemplate(id): Promise<AxiosResponse<IEmailTemplate, any>>
Get email template by id
Parameters
- id: number
  
  email template id
Returns Promise<AxiosResponse<IEmailTemplate, any>>
Email template entity

getEmailTemplates

getEmailTemplates(params, signal?): Promise<AxiosResponse<IResponseWithMeta<IEmailTemplate>, any>>
Get email templates list with filters
Parameters
- params: Partial<IEmailTemplateFilter>
  
  email templates list filter params
- Optional signal: AbortSignal
  
  abort signal
Returns Promise<AxiosResponse<IResponseWithMeta<IEmailTemplate>, any>>
Array email templates entity

massDeletionEmailTemplates

massDeletionEmailTemplates(id, all, params): Promise<AxiosResponse<any, any>>
Mass deletion email templates
Parameters
- id: number[]
  
  email template ids array
- all: boolean
  
  all email templates flag
- params: Partial<IEmailTemplateFilter>
  
  email templates list filter params
Returns Promise<AxiosResponse<any, any>>

massEditingEmailTemplates

massEditingEmailTemplates(id, payload, all, params): Promise<AxiosResponse<any, any>>
Mass editing email templates
Parameters
- id: number[]
  
  email template ids array
- payload: Partial<IEmailTemplate>
  
  email template payload
- all: boolean
  
  all email templates flag
- params: Partial<IEmailTemplateFilter>
  
  email templates list filter params
Returns Promise<AxiosResponse<any, any>>

updateEmailTemplate

updateEmailTemplate(id, data): Promise<AxiosResponse<IEmailTemplate, any>>
Update email template
Parameters
- id: number
  
  email template id
- data: Partial<IEmailTemplate>
  
  email template payload
Returns Promise<AxiosResponse<IEmailTemplate, any>>
Email template entity

Generated using TypeDoc