Marketing service

Hierarchy

  • MarketingService

Constructors

Properties

httpClient: HttpClient
namespaceNewsletters: string = '/marketing/v1/newsletters'
namespaceTemplates: string = '/marketing/v1/templates'

Methods

  • Create domain

    Parameters

    • data: {
          domain: string;
      }

      domain payload

      • domain: string

    Returns Promise<AxiosResponse<IDomain, any>>

    Domain entity

  • Create email newsletter

    Parameters

    Returns Promise<AxiosResponse<IEmailNewsletter, any>>

    Email newsletter entity

  • Create email template

    Parameters

    Returns Promise<AxiosResponse<IEmailTemplate, any>>

    Email template entity

  • Create sender

    Parameters

    • data: Partial<ISender>

      sender payload

    Returns Promise<AxiosResponse<ISender, any>>

    Sender entity

  • Delete domain

    Parameters

    • id: number

      domain id

    Returns Promise<AxiosResponse<any, any>>

  • Delete email newsletter

    Parameters

    • id: number

      email newsletter id

    Returns Promise<AxiosResponse<any, any>>

  • Delete email template

    Parameters

    • id: number

      email template id

    Returns Promise<AxiosResponse<any, any>>

  • Delete sender

    Parameters

    • id: number

      sender id

    Returns Promise<AxiosResponse<any, any>>

  • Get domain by id

    Parameters

    • id: number

      domain id

    Returns Promise<AxiosResponse<IDomain, any>>

    Domain entity

  • Get domain status

    Parameters

    • id: number

      domain id

    Returns Promise<AxiosResponse<IDomain, any>>

    Domain entity

  • Get domains list

    Returns Promise<AxiosResponse<IDomain[], any>>

    Array domains entity

  • Get email newsletter by id

    Parameters

    • id: number

      email newsletter id

    Returns Promise<AxiosResponse<IEmailNewsletter, any>>

    Email newsletter entity

  • Get email newsletter by id with statistics

    Parameters

    • id: number

      email newsletter id

    Returns Promise<AxiosResponse<IEmailNewsletter, any>>

    Email newsletter entity with statistics

  • Get email template by id

    Parameters

    • id: number

      email template id

    Returns Promise<AxiosResponse<IEmailTemplate, any>>

    Email template entity

  • Get sender by id

    Parameters

    • id: number

      sender id

    Returns Promise<AxiosResponse<ISender, any>>

    Sender entity

  • Get senders list

    Returns Promise<AxiosResponse<ISender[], any>>

    Array senders entity

  • 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>>

  • 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>>

  • 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>>

  • Mass send email newsletters

    Parameters

    • ids: number[]
    • all: boolean
    • params: Partial<IMarketingFilter>

      email newsletters list filter params

    Returns Promise<AxiosResponse<any, any>>

  • Send email newsletter

    Parameters

    • id: number

      email newsletter id

    Returns Promise<AxiosResponse<any, any>>

  • Start email newsletter mailings

    Returns Promise<AxiosResponse<any, any>>

  • Update email newsletter

    Parameters

    • id: number

      email newsletter id

    • data: Partial<IEmailNewsletter>

      email newsletter payload

    Returns Promise<AxiosResponse<IEmailNewsletter, any>>

    Email newsletter entity

  • Update email template

    Parameters

    • id: number

      email template id

    • data: Partial<IEmailTemplate>

      email template payload

    Returns Promise<AxiosResponse<IEmailTemplate, any>>

    Email template entity

  • Update sender

    Parameters

    • id: number

      sender id

    • data: Partial<ISender>

      sender payload

    Returns Promise<AxiosResponse<ISender, any>>

    Sender entity

Generated using TypeDoc