Class: TasksAPI

new TasksAPI(rest)

This class is used to interact with Tasks in TidyHQ.

Parameters:

Name	Type	Description
`rest`	Rest	The rest instance to use for requests.

Source: src/Tasks.js, line 15

Methods

(async) createTask(contact_id, title, due_date, optionsopt) → {Promise.<TidyAPI_V1_Task>}

Create a new task.

Parameters:

Name Type Attributes Default Description

contact_id string The ID of the contact to assign the task to.

title string The title of the task.

due_date string The due date of the task in ISO 8601 format.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`description`	string	<optional>	The description of the task.

Source: src/Tasks.js, line 90

Returns:

- The new task.

Type:: Promise.<TidyAPI_V1_Task>

(async) deleteTask(task_id, optionsopt) → {Promise.<TidyAPI_Response>}

Delete a task.

Parameters:

Name Type Attributes Default Description

task_id string The ID of the task.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Tasks.js, line 126

Returns:

- Success or failure.

Type:: Promise.<TidyAPI_Response>

(async) getContactTasks(contact_id, optionsopt) → {Promise.<TidyAPI_V1_Tasks>}

Get a list of all tasks for a contact.

Parameters:

Name Type Attributes Default Description

contact_id string The ID of the contact.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	string	<optional>	The number of results to return.
`offset`	string	<optional>	The number of results to skip.
`completed`	boolean	<optional>	Return only completed tasks or not.

Source: src/Tasks.js, line 64

Returns:

- The list of tasks.

Type:: Promise.<TidyAPI_V1_Tasks>

(async) getTask(task_id, optionsopt) → {Promise.<TidyAPI_V1_Task>}

Get a single task.

Parameters:

Name Type Attributes Default Description

task_id string The ID of the task.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Tasks.js, line 75

Returns:

- The task.

Type:: Promise.<TidyAPI_V1_Task>

(async) getTasks(optionsopt) → {Promise.<TidyAPI_V1_Tasks>}

Get a list of all tasks.

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	string	<optional>	The number of results to return.
`offset`	string	<optional>	The number of results to skip.
`completed`	boolean	<optional>	Return only completed tasks or not.

Source: src/Tasks.js, line 50

Returns:

- The list of tasks.

Type:: Promise.<TidyAPI_V1_Tasks>

(async) updateTask(task_id, optionsopt) → {Promise.<TidyAPI_V1_Task>}

Update a task.

Parameters:

Name Type Attributes Description

task_id string The ID of the task.

options

object

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`contact_id`	string	<optional>	The ID of the contact to assign the task to.
`title`	string	<optional>	The title of the task.
`due_date`	string	<optional>	The due date of the task in ISO 8601 format.
`description`	string	<optional>	The description of the task.
`completed`	boolean	<optional>	Whether the task is completed or not.

Source: src/Tasks.js, line 112

Returns:

- The updated task.

Type:: Promise.<TidyAPI_V1_Task>