Class CrmLeadsService

CrmLeads service

Hierarchy

CrmLeadsService

Index

Constructors

Properties

entitiesNamespace httpClient namespace

Methods

createLead createLeadField deleteLead deleteLeadField deleteLeadListValues getLeadFields getLeadsByStage getLeadsWithFilters massLeadsDeletion massLeadsEditing moveLeadFromStageToStage updateLead updateLeadField updateLeadListValues

Constructors

constructor

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

Properties

`Private` entitiesNamespace

entitiesNamespace: string = '/crm/v1/entities'

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/crm/v1/entities/leads'

Methods

createLead

createLead(data): Promise<AxiosResponse<IEntityData, any>>
Create lead
Parameters
- data: Partial<IEntityData>
  
  lead data without id
Returns Promise<AxiosResponse<IEntityData, any>>
lead entity

createLeadField

createLeadField(data): Promise<AxiosResponse<IField, any>>
Create lead field
Parameters
- data: IField
  
  lead field data
Returns Promise<AxiosResponse<IField, any>>
lead field

deleteLead

deleteLead(id): Promise<AxiosResponse<IEntityData, any>>
Delete lead
Parameters
- id: number
  
  lead id
Returns Promise<AxiosResponse<IEntityData, any>>

deleteLeadField

deleteLeadField(code): Promise<AxiosResponse<IEntityData, any>>
Delete lead field
Parameters
- code: string
  
  lead field code
Returns Promise<AxiosResponse<IEntityData, any>>

deleteLeadListValues

deleteLeadListValues(value, fieldCode): Promise<AxiosResponse<IEntityData, any>>
Delete lead list values
Parameters
- value: string
  
  lead list value
- fieldCode: string
  
  lead field code
Returns Promise<AxiosResponse<IEntityData, any>>

getLeadFields

getLeadFields(): Promise<AxiosResponse<IFields, any>>
Get lead fields

Returns Promise<AxiosResponse<IFields, any>>
lead field list

getLeadsByStage

getLeadsByStage(stageId): Promise<AxiosResponse<IEntity, any>>
Get crm leads list
Parameters
- stageId: number
Returns Promise<AxiosResponse<IEntity, any>>
Array crm leads list with meta

getLeadsWithFilters

getLeadsWithFilters(params, signal, relatedEntityId?, relatedEntityType?): Promise<AxiosResponse<IEntity, any>>
Get leads list with filters
Parameters
- params: string
  
  leads list filter params
- signal: AbortSignal
  
  AbortSignal for cancelling request
- Optional relatedEntityId: string
  
  related entity id if fetching related to entity leads
- Optional relatedEntityType: string
  
  related entity type if fetching related to entity leads
Returns Promise<AxiosResponse<IEntity, any>>
Array crm leads list

massLeadsDeletion

massLeadsDeletion(__namedParameters): Promise<AxiosResponse<any, any>>
Mass deleting leads
Parameters
- __namedParameters: IMassActions
Returns Promise<AxiosResponse<any, any>>

massLeadsEditing

massLeadsEditing(__namedParameters): Promise<AxiosResponse<any, any>>
Mass editing leads
Parameters
- __namedParameters: IMassActions
Returns Promise<AxiosResponse<any, any>>

moveLeadFromStageToStage

moveLeadFromStageToStage(entityId, stageId, reasonId): Promise<AxiosResponse<any, any>>
Move lead from stage to stage
Parameters
- entityId: number
  
  lead id
- stageId: number
  
  stage id
- reasonId: number
  
  reason id
Returns Promise<AxiosResponse<any, any>>
lead entity

updateLead

updateLead(id, data): Promise<AxiosResponse<IEntityData, any>>
Update lead
Parameters
- id: number
  
  lead id
- data: Partial<IEntityData>
  
  lead data
Returns Promise<AxiosResponse<IEntityData, any>>
lead entity

updateLeadField

updateLeadField(data): Promise<AxiosResponse<IField, any>>
Update lead field
Parameters
- data: IField
  
  lead field data
Returns Promise<AxiosResponse<IField, any>>
lead field

updateLeadListValues

updateLeadListValues(data): Promise<AxiosResponse<IFieldValue[], any>>
Update lead list values
Parameters
- data: IField
  
  lead field data
Returns Promise<AxiosResponse<IFieldValue[], any>>
values of lead field

Generated using TypeDoc