Class CrmDealsService

CrmDeals service

Hierarchy

  • CrmDealsService

Constructors

constructor

Properties

entitiesNamespace httpClient namespace

Methods

createDeal createDealField deleteDeal deleteDealField deleteDealListValues getDealFields getDeals getDealsWithFilters massDealsDeletion massDealsEditing moveDealFromStageToStage updateDeal updateDealField updateDealListValues

Constructors

constructor

Properties

Private entitiesNamespace

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

Private httpClient

httpClient: HttpClient

Private namespace

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

Methods

createDeal

  • Create deal

    Parameters

    Returns Promise<AxiosResponse<IEntityData, any>>

    deal entity

createDealField

  • Create deal field

    Parameters

    • data: IField

      deal field data

    Returns Promise<AxiosResponse<IField, any>>

    deal field

deleteDeal

  • Delete deal

    Parameters

    • id: number

      deal id

    Returns Promise<AxiosResponse<IEntityData, any>>

deleteDealField

  • Delete deal field

    Parameters

    • code: string

      deal field code

    Returns Promise<AxiosResponse<IEntityData, any>>

deleteDealListValues

  • Delete deal list values

    Parameters

    • value: string

      deal list value

    • fieldCode: string

      deal field code

    Returns Promise<AxiosResponse<IEntityData, any>>

getDealFields

  • Get deal fields

    Returns Promise<AxiosResponse<IFields, any>>

    deal field list

getDeals

  • Get crm deals list

    Returns Promise<AxiosResponse<IEntity, any>>

    Array crm deals list with meta

getDealsWithFilters

  • Get deals list with filters

    Parameters

    • params: string

      deals list filter params

    • signal: AbortSignal

      AbortSignal for cancelling request

    • Optional relatedEntityId: string

      related entity id if fetching related to entity deals

    • Optional relatedEntityType: string

      related entity type if fetching related to entity deals

    Returns Promise<AxiosResponse<IEntity, any>>

    Array crm deals list

massDealsDeletion

  • Mass deleting deals

    Parameters

    Returns Promise<AxiosResponse<any, any>>

massDealsEditing

  • Mass editing deals

    Parameters

    Returns Promise<AxiosResponse<any, any>>

moveDealFromStageToStage

  • Move deal from stage to stage

    Parameters

    • entityId: number

      deal id

    • stageId: number

      stage id

    • reasonId: number

      reason id

    Returns Promise<AxiosResponse<any, any>>

    deal entity

updateDeal

  • Update deal

    Parameters

    • id: number

      deal id

    • data: Partial<IEntityData>

      deal data

    Returns Promise<AxiosResponse<IEntityData, any>>

    deal entity

updateDealField

  • Update deal field

    Parameters

    • data: IField

      deal field data

    Returns Promise<AxiosResponse<IField, any>>

    deal field

updateDealListValues

  • Update deal list values

    Parameters

    • data: IField

      deal field data

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

    values of deal field

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc