Class TasksService

Tasks service

Hierarchy

TasksService

Index

Constructors

constructor

Properties

httpClient namespace namespaceTemplates namespaceTransferTasks namespaceTrashTasks

Constructors

constructor

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

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/tasks/v1/tasks'

`Private` namespaceTemplates

namespaceTemplates: string = '/tasks/v1/templates'

`Private` namespaceTransferTasks

namespaceTransferTasks: string = '/tasks/v1/transfers'

`Private` namespaceTrashTasks

namespaceTrashTasks: string = '/tasks/v1/trash/tasks'

Methods

completeTask

completeTask(id): Promise<AxiosResponse<ITask, any>>
complete task
Parameters
- id: string
  
  task id
Returns Promise<AxiosResponse<ITask, any>>
task entity

createChecklist

createChecklist(taskId, body): Promise<AxiosResponse<ITask, any>>
Create checklist
Parameters
- taskId: string
- body: Partial<IChecklist>
Returns Promise<AxiosResponse<ITask, any>>
checklist entity

createChecklistItem

createChecklistItem(id, body): Promise<AxiosResponse<ITask, any>>
Create checklist item
Parameters
- id: number
  
  checklist id
- body: Partial<IChecklistItem>
  
  checklist item entity
Returns Promise<AxiosResponse<ITask, any>>
checklist item entity

createOneTimeTemplate

createOneTimeTemplate(body): Promise<AxiosResponse<ITask, any>>
Create one time template
Parameters
- body: Partial<ITask>
Returns Promise<AxiosResponse<ITask, any>>
one time template entity

createRecurringTemplate

createRecurringTemplate(body): Promise<AxiosResponse<ITask, any>>
Create recurring template
Parameters
- body: Partial<ITask>
Returns Promise<AxiosResponse<ITask, any>>
recurring template entity

createTask

createTask(body): Promise<AxiosResponse<ITask, any>>
Create task
Parameters
- body: Partial<ITask>
Returns Promise<AxiosResponse<ITask, any>>
task entity

createTasksField

createTasksField(data): Promise<AxiosResponse<IField, any>>
Create tasks field
Parameters
- data: Partial<IField>
  
  field data
Returns Promise<AxiosResponse<IField, any>>
tasks field

delegationTask

delegationTask(id, user_id): Promise<AxiosResponse<ITask, any>>
Delegation task
Parameters
- id: string
  
  task id
- user_id: number
  
  user id
Returns Promise<AxiosResponse<ITask, any>>
task entity

deleteChecklist

deleteChecklist(id): Promise<AxiosResponse<ITask, any>>
Delete checklist
Parameters
- id: number
  
  checklist id
Returns Promise<AxiosResponse<ITask, any>>

deleteChecklistItem

deleteChecklistItem(id, itemId): Promise<AxiosResponse<ITask, any>>
Delete checklist item
Parameters
- id: number
  
  checklist id
- itemId: number
  
  checklist item id
Returns Promise<AxiosResponse<ITask, any>>
checklist item entity

deleteTask

deleteTask(id): Promise<AxiosResponse<ITask, any>>
Delete task
Parameters
- id: string
  
  task id
Returns Promise<AxiosResponse<ITask, any>>

deleteTasksField

deleteTasksField(fieldCode): Promise<AxiosResponse<any, any>>
Delete tasks field
Parameters
- fieldCode: string
  
  field code
Returns Promise<AxiosResponse<any, any>>

deleteTasksListValues

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

deleteTrashTasks

deleteTrashTasks(__namedParameters): Promise<AxiosResponse<any, any>>
Remove from basket tasks
Parameters
- __namedParameters: {
      all: boolean;
      exceptIds: number[];
      filterParams?: object;
      itemIds: number[];
  }
  - all: boolean
  - exceptIds: number[]
  - Optional filterParams?: object
  - itemIds: number[]
Returns Promise<AxiosResponse<any, any>>

getHierarchies

getHierarchies(params, withoutResponsible, signal): Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Get hierarchies list
Parameters
- params: ITasksParams
  
  one hierarchies filter params
- withoutResponsible: boolean
  
  withoutResponsible filter param
- signal: AbortSignal
Returns Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Array hierarchy entity

getOneTimeTemplate

getOneTimeTemplate(id, crm_entity_list?): Promise<AxiosResponse<ITask, any>>
Get one time template by id
Parameters
- id: string
  
  one time template id
- Optional crm_entity_list: boolean
Returns Promise<AxiosResponse<ITask, any>>
one time template entity

getOneTimeTemplates

getOneTimeTemplates(params, withoutResponsible?, signal?): Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Get one time templates list
Parameters
- params: ITasksParams
  
  one time templates filter params
- Optional withoutResponsible: boolean
  
  withoutResponsible filter param
- Optional signal: AbortSignal
Returns Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Array one time template entity

getParentTask

getParentTask(id): Promise<AxiosResponse<ITask, any>>
Get parentTask by id
Parameters
- id: string
  
  parentTask id
Returns Promise<AxiosResponse<ITask, any>>
parentTask entity

getRecurringTemplate

getRecurringTemplate(id, crm_entity_list?): Promise<AxiosResponse<ITask, any>>
Get recurring template by id
Parameters
- id: string
  
  recurring template id
- Optional crm_entity_list: boolean
Returns Promise<AxiosResponse<ITask, any>>
recurring template entity

getRecurringTemplates

getRecurringTemplates(params, withoutResponsible?, signal?): Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Get recurring templates list
Parameters
- params: ITasksParams
  
  recurring templates filter params
- Optional withoutResponsible: boolean
  
  withoutResponsible filter param
- Optional signal: AbortSignal
Returns Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Array recurring template entity

getSubtasks

getSubtasks(id, isTemplate, params): Promise<AxiosResponse<IResponseWithMeta<ITasks>, any>>
Get subtasks list
Parameters
- id: string
  
  parent task/template id
- isTemplate: boolean
  
  template param
- params: Partial<ITasksParams>
  
  subtasks list filter params
Returns Promise<AxiosResponse<IResponseWithMeta<ITasks>, any>>
Array subtasks entity

getTask

getTask(id, crm_entity_list?): Promise<AxiosResponse<ITask, any>>
Get task by id
Parameters
- id: string
  
  task id
- Optional crm_entity_list: boolean
Returns Promise<AxiosResponse<ITask, any>>
task entity

getTasks

getTasks(params, withoutResponsible?, signal?): Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Get tasks list with filters
Parameters
- params: ITasksParams
  
  tasks list filter params
- Optional withoutResponsible: boolean
  
  withoutResponsible filter param
- Optional signal: AbortSignal
Returns Promise<AxiosResponse<IResponseWithMeta<ITask>, any>>
Array tasks entity

getTasksField

getTasksField(): Promise<AxiosResponse<IFields, any>>
Get tasks fields

Returns Promise<AxiosResponse<IFields, any>>
tasks fields

getTasksFields

getTasksFields(): Promise<AxiosResponse<IResponseWithMeta<IField>, any>>
Get tasks fields

Returns Promise<AxiosResponse<IResponseWithMeta<IField>, any>>
tasks fields

getTransferTasksProgress

getTransferTasksProgress(): Promise<AxiosResponse<ITransferOfCasesProgress, any>>
Transfer tasks progress

Returns Promise<AxiosResponse<ITransferOfCasesProgress, any>>
transfer tasks progress

getTransferTasksQuantity

getTransferTasksQuantity(body): Promise<AxiosResponse<ITransferTasksData, any>>
Transfer tasks quantity
Parameters
- body: Partial<ITransferTasksData>
Returns Promise<AxiosResponse<ITransferTasksData, any>>
transfer tasks quantity

getTrashTask

getTrashTask(id): Promise<AxiosResponse<ITask, any>>
Get deleted(trash) task
Parameters
- id: number
  
  item id
Returns Promise<AxiosResponse<ITask, any>>
activity item

getTrashTasks

getTrashTasks(params, signal?): Promise<AxiosResponse<ITasks, any>>
Get deleted(trash) tasks
Parameters
- params: string | object
  
  task list filter params
- Optional signal: AbortSignal
  
  AbortSignal for cancelling request
Returns Promise<AxiosResponse<ITasks, any>>
activity list

massCompletionTasks

massCompletionTasks(taskIds, exceptIds, all, params?, withoutResponsible?): Promise<AxiosResponse<any, any>>
Mass completion tasks
Parameters
- taskIds: string[]
  
  tasks ids
- exceptIds: number[]
  
  exception tasks ids
- all: boolean
  
  boolean flag for params
- Optional params: ITasksParams
  
  params for filters
- Optional withoutResponsible: boolean
  
  boolean flag for filters
Returns Promise<AxiosResponse<any, any>>

massDeletionTasks

massDeletionTasks(taskIds, exceptIds, all, params?, withoutResponsible?): Promise<AxiosResponse<any, any>>
Mass deletion tasks
Parameters
- taskIds: string[]
  
  tasks ids
- exceptIds: number[]
  
  exception tasks ids
- all: boolean
  
  boolean flag for params
- Optional params: ITasksParams
  
  params for filters
- Optional withoutResponsible: boolean
  
  boolean flag for filters
Returns Promise<AxiosResponse<any, any>>

massEditingTasks

massEditingTasks(taskIds, exceptIds, all, params?, withoutResponsible?, payload?, settings?): Promise<AxiosResponse<any, any>>
Mass editing tasks
Parameters
- taskIds: string[]
  
  tasks ids
- exceptIds: number[]
  
  exception tasks ids
- all: boolean
  
  boolean flag for params
- Optional params: ITasksParams
  
  params for filters
- Optional withoutResponsible: boolean
  
  boolean flag for filters
- Optional payload: IMassEditingFieldsPayload
  
  mass editing values
- Optional settings: IMassEditingFieldsPayload
  
  mass editing field settings
Returns Promise<AxiosResponse<any, any>>

pauseTask

pauseTask(id): Promise<AxiosResponse<ITask, any>>
Pause task
Parameters
- id: string
  
  task id
Returns Promise<AxiosResponse<ITask, any>>
task entity

replicateTask

replicateTask(body, id): Promise<AxiosResponse<ITask, any>>
Replicate task
Parameters
- body: Partial<ITask>
- id: string
Returns Promise<AxiosResponse<ITask, any>>
task entity

restartTask

restartTask(id): Promise<AxiosResponse<ITask, any>>
Restart task
Parameters
- id: string
  
  task id
Returns Promise<AxiosResponse<ITask, any>>
task entity

restoreTrashTasks

restoreTrashTasks(__namedParameters): Promise<AxiosResponse<any, any>>
Restore tasks
Parameters
- __namedParameters: {
      all: boolean;
      exceptIds: number[];
      filterParams?: object;
      itemIds: number[];
  }
  - all: boolean
  - exceptIds: number[]
  - Optional filterParams?: object
  - itemIds: number[]
Returns Promise<AxiosResponse<any, any>>

startTask

startTask(id): Promise<AxiosResponse<ITask, any>>
Start task
Parameters
- id: string
  
  task id
Returns Promise<AxiosResponse<ITask, any>>
task entity

stopTransferTasks

stopTransferTasks(): Promise<AxiosResponse<any, any>>
Stop transfer tasks

Returns Promise<AxiosResponse<any, any>>

transferTasks

transferTasks(body): Promise<AxiosResponse<ITransferTasksData, any>>
Transfer tasks
Parameters
- body: Partial<ITransferTasksData>
Returns Promise<AxiosResponse<ITransferTasksData, any>>
transfer tasks quantity

unwatchTask

unwatchTask(id): Promise<AxiosResponse<ITask, any>>
Unwatch task
Parameters
- id: string
  
  task id
Returns Promise<AxiosResponse<ITask, any>>
task entity

updateChecklist

updateChecklist(id, body): Promise<AxiosResponse<ITask, any>>
Update checklist
Parameters
- id: number
  
  checklist id
- body: Partial<IChecklist>
  
  checklist entity
Returns Promise<AxiosResponse<ITask, any>>
checklist entity

updateChecklistItem

updateChecklistItem(id, itemId, body): Promise<AxiosResponse<ITask, any>>
Update checklist item
Parameters
- id: number
  
  checklist id
- itemId: number
  
  checklist item id
- body: Partial<IChecklistItem>
  
  checklist item entity
Returns Promise<AxiosResponse<ITask, any>>
checklist item entity

updateOneTimeTemplate

updateOneTimeTemplate(id, body): Promise<AxiosResponse<ITask, any>>
Update one time template
Parameters
- id: string
  
  one time template id
- body: Partial<ITask>
Returns Promise<AxiosResponse<ITask, any>>
one time template entity

updateRecurringTemplate

updateRecurringTemplate(id, body): Promise<AxiosResponse<ITask, any>>
Update recurring template
Parameters
- id: string
  
  recurring template id
- body: Partial<ITask>
Returns Promise<AxiosResponse<ITask, any>>
recurring template entity

updateSubtask

updateSubtask(id, body): Promise<AxiosResponse<ITask, any>>
Update subtask
Parameters
- id: string
  
  subtask id
- body: Partial<ITask>
Returns Promise<AxiosResponse<ITask, any>>
subtask entity

updateTask

updateTask(id, body): Promise<AxiosResponse<ITask, any>>
Update task
Parameters
- id: string
  
  task id
- body: Partial<ITask>
Returns Promise<AxiosResponse<ITask, any>>
task entity

updateTasksField

updateTasksField(fieldCode, data): Promise<AxiosResponse<IField, any>>
Update tasks field
Parameters
- fieldCode: string
  
  field code
- data: IField
  
  field data
Returns Promise<AxiosResponse<IField, any>>
entity field

updateTasksListValues

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

watchTask

watchTask(id): Promise<AxiosResponse<ITask, any>>
Watch task
Parameters
- id: string
  
  task id
Returns Promise<AxiosResponse<ITask, any>>
task entity

Class TasksService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

httpClient: HttpClient

Returns TasksService

Properties

Private httpClient

Private namespace

Private namespaceTemplates

Private namespaceTransferTasks

Private namespaceTrashTasks

Methods

completeTask

Parameters

id: string

Returns Promise<AxiosResponse<ITask, any>>

createChecklist

Parameters

taskId: string

body: Partial<IChecklist>

Returns Promise<AxiosResponse<ITask, any>>

createChecklistItem

Parameters

id: number

body: Partial<IChecklistItem>

Returns Promise<AxiosResponse<ITask, any>>

createOneTimeTemplate

Parameters

body: Partial<ITask>

Returns Promise<AxiosResponse<ITask, any>>

createRecurringTemplate

Parameters

body: Partial<ITask>

Returns Promise<AxiosResponse<ITask, any>>

createTask

Parameters

body: Partial<ITask>

Returns Promise<AxiosResponse<ITask, any>>

createTasksField

Parameters

data: Partial<IField>

Returns Promise<AxiosResponse<IField, any>>

delegationTask

Parameters

id: string

user_id: number

Returns Promise<AxiosResponse<ITask, any>>

deleteChecklist

Parameters

id: number

Returns Promise<AxiosResponse<ITask, any>>

deleteChecklistItem

Parameters

id: number

itemId: number

Returns Promise<AxiosResponse<ITask, any>>

deleteTask

Parameters

id: string

Returns Promise<AxiosResponse<ITask, any>>

deleteTasksField

Parameters

fieldCode: string

Returns Promise<AxiosResponse<any, any>>

deleteTasksListValues

Parameters

fieldCode: string

value: string

Returns Promise<AxiosResponse<any, any>>

deleteTrashTasks

Parameters

__namedParameters: { all: boolean; exceptIds: number[]; filterParams?: object; itemIds: number[]; }

all: boolean

exceptIds: number[]

`Private` httpClient

`Private` namespace

`Private` namespaceTemplates

`Private` namespaceTransferTasks

`Private` namespaceTrashTasks

__namedParameters: {
all: boolean;
exceptIds: number[];
filterParams?: object;
itemIds: number[];
}

`Optional` filterParams?: object

`Optional` crm_entity_list: boolean

`Optional` withoutResponsible: boolean

`Optional` signal: AbortSignal

`Optional` crm_entity_list: boolean

`Optional` withoutResponsible: boolean

`Optional` signal: AbortSignal

`Optional` crm_entity_list: boolean

`Optional` withoutResponsible: boolean

`Optional` signal: AbortSignal

`Optional` signal: AbortSignal