Class CrmProductsService

CrmProducts service

Hierarchy

CrmProductsService

Index

Constructors

Properties

dynamicNamespace httpClient namespace

Methods

createProduct createProductField deleteProduct deleteProductField deleteProductListValues getProductFields getProducts getProductsWithFilters massProductsDeletion massProductsEditing updateProduct updateProductField updateProductListValues

Constructors

constructor

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

Properties

`Private` dynamicNamespace

dynamicNamespace: string = '/crm/v1/entities/products'

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/crm/v1/static/products'

Methods

createProduct

createProduct(data): Promise<AxiosResponse<IProduct, any>>
Create product
Parameters
- data: Partial<IProduct>
  
  product data without id
Returns Promise<AxiosResponse<IProduct, any>>
product entity

createProductField

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

deleteProduct

deleteProduct(id): Promise<AxiosResponse<any, any>>
Delete product
Parameters
- id: number
  
  product id
Returns Promise<AxiosResponse<any, any>>

deleteProductField

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

deleteProductListValues

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

getProductFields

getProductFields(): Promise<AxiosResponse<IFields, any>>
Get product fields

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

getProducts

getProducts(): Promise<AxiosResponse<IProducts, any>>
Get crm products list

Returns Promise<AxiosResponse<IProducts, any>>
Array crm products list with meta

getProductsWithFilters

getProductsWithFilters(params, signal?): Promise<AxiosResponse<IResponseWithMeta<IProduct>, any>>
Get products list with filters
Parameters
- params: Omit<IProductFilters, "openDatePicker">
  
  products list filter params
- Optional signal: AbortSignal
  
  AbortSignal for cancelling request
Returns Promise<AxiosResponse<IResponseWithMeta<IProduct>, any>>
Array crm products list

massProductsDeletion

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

massProductsEditing

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

updateProduct

updateProduct(id, data): Promise<AxiosResponse<IProduct, any>>
Update product
Parameters
- id: number
  
  product id
- data: Partial<IProduct>
  
  product data
Returns Promise<AxiosResponse<IProduct, any>>
product entity

updateProductField

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

updateProductListValues

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

Generated using TypeDoc