Class CrmDocumentTemplatesService

CrmDocumentTemplates service

Hierarchy

CrmDocumentTemplatesService

Index

Constructors

Properties

httpClient namespace

Methods

createTemplate deleteArrayTemplates deleteTemplate getDocumentTemplates getDocumentTemplatesFields updateTemplate

Constructors

constructor

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

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/crm/v1/documents/templates'

Methods

createTemplate

createTemplate(data): Promise<AxiosResponse<IDocumentTemplate, any>>
Create crm document template
Parameters
- data: Partial<IDocumentTemplate>
  
  document template data
Returns Promise<AxiosResponse<IDocumentTemplate, any>>
document template

deleteArrayTemplates

deleteArrayTemplates(ids): Promise<AxiosResponse<any, any>>
Mass delete document templates
Parameters
- ids: number[]
  
  document template ids
Returns Promise<AxiosResponse<any, any>>

deleteTemplate

deleteTemplate(id): Promise<AxiosResponse<any, any>>
Delete document template
Parameters
- id: number
  
  document template id
Returns Promise<AxiosResponse<any, any>>

getDocumentTemplates

getDocumentTemplates(params, signal): Promise<AxiosResponse<IDocumentTemplates, any>>
Get crm document templates list
Parameters
- params: IDocumentTemplateFilters
  
  document templates filter params
- signal: AbortSignal
  
  AbortSignal for cancelling request
Returns Promise<AxiosResponse<IDocumentTemplates, any>>
CRM document templates list with meta

getDocumentTemplatesFields

getDocumentTemplatesFields(params, signal): Promise<AxiosResponse<IDocumentTemplateFields, any>>
Get crm document templates fields
Parameters
- params: IDocumentTemplateFieldFilters
  
  document template fields filter params
- signal: AbortSignal
  
  AbortSignal for cancelling request
Returns Promise<AxiosResponse<IDocumentTemplateFields, any>>
document templates fields

updateTemplate

updateTemplate(id, data): Promise<AxiosResponse<IDocumentTemplate, any>>
Update crm document template
Parameters
- id: number
  
  document template id
- data: Partial<IDocumentTemplate>
  
  document template data
Returns Promise<AxiosResponse<IDocumentTemplate, any>>
document template

Generated using TypeDoc