Class CrmCompaniesService

CrmCompanies service

Hierarchy

CrmCompaniesService

Index

Constructors

Properties

entitiesNamespace httpClient namespace

Methods

createCompany createCompanyField deleteCompany deleteCompanyField deleteCompanyListValues getCompanies getCompaniesWithFilters getCompanyFields massCompaniesDeletion massCompaniesEditing updateCompany updateCompanyField updateCompanyListValues

Constructors

constructor

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

Properties

`Private` entitiesNamespace

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

`Private` httpClient

httpClient: HttpClient

`Private` namespace

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

Methods

createCompany

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

createCompanyField

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

deleteCompany

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

deleteCompanyField

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

deleteCompanyListValues

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

getCompanies

getCompanies(): Promise<AxiosResponse<IEntity, any>>
Get crm companies list

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

getCompaniesWithFilters

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

getCompanyFields

getCompanyFields(): Promise<AxiosResponse<IFields, any>>
Get company fields

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

massCompaniesDeletion

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

massCompaniesEditing

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

updateCompany

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

updateCompanyField

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

updateCompanyListValues

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

Generated using TypeDoc