Class CrmContactsService

CrmContacts service

Hierarchy

CrmContactsService

Index

Constructors

Properties

entitiesNamespace httpClient namespace

Methods

createContact createContactField deleteContact deleteContactField deleteContactListValues getContactFields getContacts getContactsWithFilters massContactsDeletion massContactsEditing updateContact updateContactField updateContactListValues

Constructors

constructor

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

Properties

`Private` entitiesNamespace

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

`Private` httpClient

httpClient: HttpClient

`Private` namespace

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

Methods

createContact

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

createContactField

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

deleteContact

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

deleteContactField

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

deleteContactListValues

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

getContactFields

getContactFields(): Promise<AxiosResponse<IFields, any>>
Get contact fields

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

getContacts

getContacts(): Promise<AxiosResponse<IEntity, any>>
Get crm contacts list

Returns Promise<AxiosResponse<IEntity, any>>
Array crm contacts list with meta

getContactsWithFilters

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

massContactsDeletion

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

massContactsEditing

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

updateContact

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

updateContactField

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

updateContactListValues

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

Generated using TypeDoc