Class CrmTasksService

CrmTasks service

Hierarchy

CrmTasksService

Constructors

constructor

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

Properties

`Private` calendarsNamespace

calendarsNamespace: string = '/activities/v1/calendars'

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/activities/v1/activities'

`Private` oauthIntegrationsNamespace

oauthIntegrationsNamespace: string = '/activities/v1/integrations'

Methods

activateServicesAccountSync

activateServicesAccountSync(id): Promise<AxiosResponse<ICalendarsSuccessResponse, any>>
Activate calendars sync
Parameters
- id: number
Returns Promise<AxiosResponse<ICalendarsSuccessResponse, any>>

createTask

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

deleteServicesAccount

deleteServicesAccount(providerId, integrationId): Promise<AxiosResponse<ICalendarsSuccessResponse, any>>
Delete services account
Parameters
- providerId: number
- integrationId: number
Returns Promise<AxiosResponse<ICalendarsSuccessResponse, any>>

deleteTask

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

getCalendars

getCalendars(): Promise<AxiosResponse<ICalendar[], any>>
Get calendars

Returns Promise<AxiosResponse<ICalendar[], any>>
calendars list

getOAuthRedirectUrl

getOAuthRedirectUrl(provider, type): Promise<AxiosResponse<{
link: string;
}, any>>
Get OAuth 2.0 redirect url
Parameters
- provider: oauthProvider
- type: oauthType
Returns Promise<AxiosResponse<{
link: string;
}, any>>
redirect url

getOauthServicesAccounts

getOauthServicesAccounts(params?): Promise<AxiosResponse<IOAuthServicesAccount, any>>
Get oauth services accounts
Parameters
- Optional params: {
  with: string[];
  }
  - with: string[]
Returns Promise<AxiosResponse<IOAuthServicesAccount, any>>
oauth services accounts list

getTask

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

getTasks

getTasks(): Promise<AxiosResponse<ITasks, any>>
Get crm tasks list

Returns Promise<AxiosResponse<ITasks, any>>
Array crm tasks list with meta

getTasksWithFilters

getTasksWithFilters(params, signal?): Promise<AxiosResponse<ITasks, any>>
Get tasks list with filters
Parameters
- params: string | object
  
  tasks list filter params
- Optional signal: AbortSignal
  
  AbortSignal for cancelling request
Returns Promise<AxiosResponse<ITasks, any>>
Array crm tasks list

massTasksDeletion

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

massTasksEditing

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

saveCalendarsSettings

saveCalendarsSettings(body): Promise<AxiosResponse<ISaveAccountResponse, any>>
Save calendars settings
Parameters
- body: ICalendarSettings
  
  calendars settings
Returns Promise<AxiosResponse<ISaveAccountResponse, any>>
calendars list

startInitialServicesAccountSync

startInitialServicesAccountSync(body): Promise<AxiosResponse<ICalendarsSuccessResponse, any>>
Start initial account sync
Parameters
- body: ISyncSettings
  
  initial sync settings
Returns Promise<AxiosResponse<ICalendarsSuccessResponse, any>>

startServicesAccountSync

startServicesAccountSync(): Promise<AxiosResponse<ICalendarsSuccessResponse, any>>
Start account sync

Returns Promise<AxiosResponse<ICalendarsSuccessResponse, any>>

stopServicesAccountSync

stopServicesAccountSync(): Promise<AxiosResponse<ICalendarsSuccessResponse, any>>
Stop account sync

Returns Promise<AxiosResponse<ICalendarsSuccessResponse, any>>

updateTask

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

Generated using TypeDoc