Class MarketingService

Marketing service

Hierarchy

MarketingService

Constructors

constructor

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

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespaceNewsletters

namespaceNewsletters: string = '/marketing/v1/newsletters'

`Private` namespaceTemplates

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

Methods

createDomain

createDomain(data): Promise<AxiosResponse<IDomain, any>>
Create domain
Parameters
- data: {
  domain: string;
  }
  
  domain payload
  - domain: string
Returns Promise<AxiosResponse<IDomain, any>>
Domain entity

createEmailNewsletter

createEmailNewsletter(data): Promise<AxiosResponse<IEmailNewsletter, any>>
Create email newsletter
Parameters
- data: Partial<IEmailNewsletter>
  
  email newsletter payload
Returns Promise<AxiosResponse<IEmailNewsletter, any>>
Email newsletter entity

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

createSender

createSender(data): Promise<AxiosResponse<ISender, any>>
Create sender
Parameters
- data: Partial<ISender>
  
  sender payload
Returns Promise<AxiosResponse<ISender, any>>
Sender entity

deleteDomain

deleteDomain(id): Promise<AxiosResponse<any, any>>
Delete domain
Parameters
- id: number
  
  domain id
Returns Promise<AxiosResponse<any, any>>

deleteEmailNewsletter

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

deleteEmailTemplate

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

deleteSender

deleteSender(id): Promise<AxiosResponse<any, any>>
Delete sender
Parameters
- id: number
  
  sender id
Returns Promise<AxiosResponse<any, any>>

getDomain

getDomain(id): Promise<AxiosResponse<IDomain, any>>
Get domain by id
Parameters
- id: number
  
  domain id
Returns Promise<AxiosResponse<IDomain, any>>
Domain entity

getDomainStatus

getDomainStatus(id): Promise<AxiosResponse<IDomain, any>>
Get domain status
Parameters
- id: number
  
  domain id
Returns Promise<AxiosResponse<IDomain, any>>
Domain entity

getDomains

getDomains(): Promise<AxiosResponse<IDomain[], any>>
Get domains list

Returns Promise<AxiosResponse<IDomain[], any>>
Array domains entity

getEmailNewsletter

getEmailNewsletter(id): Promise<AxiosResponse<IEmailNewsletter, any>>
Get email newsletter by id
Parameters
- id: number
  
  email newsletter id
Returns Promise<AxiosResponse<IEmailNewsletter, any>>
Email newsletter entity

getEmailNewsletterRecipients

getEmailNewsletterRecipients(id, params): Promise<AxiosResponse<IResponseWithMeta<INewsletterRecipient>, any>>
Get email newsletter recipients
Parameters
- id: number
  
  email newsletter id
- params: Partial<INewsletterRecipientsFilter>
  
  email newsletter recipients filter params
Returns Promise<AxiosResponse<IResponseWithMeta<INewsletterRecipient>, any>>
Array email newsletter recipients entity

getEmailNewsletterStatistics

getEmailNewsletterStatistics(id): Promise<AxiosResponse<IEmailNewsletter, any>>
Get email newsletter by id with statistics
Parameters
- id: number
  
  email newsletter id
Returns Promise<AxiosResponse<IEmailNewsletter, any>>
Email newsletter entity with statistics

getEmailNewsletters

getEmailNewsletters(params, signal?): Promise<AxiosResponse<IResponseWithMeta<IEmailNewsletter>, any>>
Get email newsletters list with filters
Parameters
- params: Partial<IMarketingFilter>
  
  email newsletters list filter params
- Optional signal: AbortSignal
  
  abort signal
Returns Promise<AxiosResponse<IResponseWithMeta<IEmailNewsletter>, any>>
Array email newsletters entity

getEmailNewslettersCredits

getEmailNewslettersCredits(): Promise<AxiosResponse<IEmailNewslettersCredits, any>>
Get email newsletters credits

Returns Promise<AxiosResponse<IEmailNewslettersCredits, any>>
Email newsletters credits

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<IMarketingFilter>
  
  email templates list filter params
- Optional signal: AbortSignal
  
  abort signal
Returns Promise<AxiosResponse<IResponseWithMeta<IEmailTemplate>, any>>
Array email templates entity

getRecipientsCountsBySegments

getRecipientsCountsBySegments(data): Promise<AxiosResponse<IRecipientsCountsBySegments, any>>
Get recipients counts by segments
Parameters
- data: INewsletterPreset
Returns Promise<AxiosResponse<IRecipientsCountsBySegments, any>>
Recipients counts by segments ids

getSender

getSender(id): Promise<AxiosResponse<ISender, any>>
Get sender by id
Parameters
- id: number
  
  sender id
Returns Promise<AxiosResponse<ISender, any>>
Sender entity

getSenders

getSenders(): Promise<AxiosResponse<ISender[], any>>
Get senders list

Returns Promise<AxiosResponse<ISender[], any>>
Array senders entity

massDeletionEmailNewsletters

massDeletionEmailNewsletters(id, all, params): Promise<AxiosResponse<any, any>>
Mass deletion email newsletters
Parameters
- id: number[]
  
  email newsletter ids array
- all: boolean
- params: Partial<IMarketingFilter>
  
  email newsletters list filter params
Returns Promise<AxiosResponse<any, any>>

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<IMarketingFilter>
  
  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<IMarketingFilter>
  
  email templates list filter params
Returns Promise<AxiosResponse<any, any>>

massSendingEmailNewsletters

massSendingEmailNewsletters(ids, all, params): Promise<AxiosResponse<any, any>>
Mass send email newsletters
Parameters
- ids: number[]
- all: boolean
- params: Partial<IMarketingFilter>
  
  email newsletters list filter params
Returns Promise<AxiosResponse<any, any>>

sendEmailNewsletter

sendEmailNewsletter(id): Promise<AxiosResponse<any, any>>
Send email newsletter
Parameters
- id: number
  
  email newsletter id
Returns Promise<AxiosResponse<any, any>>

startEmailNewsletterMailings

startEmailNewsletterMailings(): Promise<AxiosResponse<any, any>>
Start email newsletter mailings

Returns Promise<AxiosResponse<any, any>>

updateEmailNewsletter

updateEmailNewsletter(id, data): Promise<AxiosResponse<IEmailNewsletter, any>>
Update email newsletter
Parameters
- id: number
  
  email newsletter id
- data: Partial<IEmailNewsletter>
  
  email newsletter payload
Returns Promise<AxiosResponse<IEmailNewsletter, any>>
Email newsletter entity

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

updateSender

updateSender(id, data): Promise<AxiosResponse<ISender, any>>
Update sender
Parameters
- id: number
  
  sender id
- data: Partial<ISender>
  
  sender payload
Returns Promise<AxiosResponse<ISender, any>>
Sender entity

Generated using TypeDoc