Package net.amcintosh.freshbooks.resources

Class Tasks

java.lang.Object

net.amcintosh.freshbooks.resources.api.Resource

net.amcintosh.freshbooks.resources.api.AccountingResource

net.amcintosh.freshbooks.resources.Tasks

public class Tasks
extends AccountingResource

FreshBooks tasks resource with calls to get, list, create, update, delete

Field Summary

Fields inherited from class net.amcintosh.freshbooks.resources.api.Resource

freshBooksClient

Constructor Summary

Constructors

Constructor	Description
Tasks(FreshBooksClient freshBooksClient)

Method Summary

Modifier and Type	Method	Description
Task	create(String accountId, Map<String,Object> data)	Create a new task from the provided data.
Task	create(String accountId, Task data)	Create a new task from the provided Task model.
Task	delete(String accountId, long taskId)	Delete the task with the corresponding id.
Task	get(String accountId, long taskId)	Get a single task with the corresponding id.
Task	get(String accountId, long taskId, IncludesQueryBuilder builder)	Get a single task with the corresponding id.
protected String	getPath()
TaskList	list(String accountId)	Get a list of tasks using the query strings generated by the QueryBuilder list.
TaskList	list(String accountId, List<QueryBuilder> builders)	Get a list of tasks using the query strings generated by the QueryBuilder list.
Task	update(String accountId, long taskId, Map<String,Object> data)	Update the task with the corresponding id.
Task	update(String accountId, long taskId, Task data)	Update the task with the corresponding id.

Methods inherited from class net.amcintosh.freshbooks.resources.api.AccountingResource

getResourceType, getUrl, getUrl, getUrl, getUrl, handleListRequest, handleRequest, handleRequest

Methods inherited from class net.amcintosh.freshbooks.resources.api.Resource

buildQueryString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Tasks

public Tasks(FreshBooksClient freshBooksClient)

Method Details

getPath

protected String getPath()

Specified by:

getPath in class AccountingResource

list

public TaskList list(String accountId)
              throws FreshBooksException

Get a list of tasks using the query strings generated by the QueryBuilder list.

Parameters:

accountId - Id of the account

Returns:

TaskList containing tasks and pagination details

Throws:

FreshBooksException - If the call is not successful

list

public TaskList list(String accountId,
 List<QueryBuilder> builders)
              throws FreshBooksException

Get a list of tasks using the query strings generated by the QueryBuilder list.

Parameters:

accountId - Id of the account

builders - List of QueryBuilders

Returns:

TaskList containing tasks and pagination details

Throws:

FreshBooksException - If the call is not successful

get

public Task get(String accountId,
 long taskId)
         throws FreshBooksException

Get a single task with the corresponding id.

Parameters:

accountId - The alpha-numeric account id

taskId - Id of the resource to return

Returns:

The Task

Throws:

FreshBooksException - If the call is not successful

get

public Task get(String accountId,
 long taskId,
 IncludesQueryBuilder builder)
         throws FreshBooksException

Get a single task with the corresponding id.

Parameters:

accountId - The alpha-numeric account id

taskId - Id of the resource to return

builder - IncludesQueryBuilder object for including additional data, sub-resources, etc.

Returns:

The Task

Throws:

FreshBooksException - If the call is not successful

create

public Task create(String accountId,
 Task data)
            throws FreshBooksException

Create a new task from the provided Task model. Makes a POST call against the task resource endpoint. This calls `task.getContent()` to get a hash map of data.

Parameters:

accountId - The alpha-numeric account id

data - Task model with create data

Returns:

The created Task

Throws:

FreshBooksException - If the call is not successful

create

public Task create(String accountId,
 Map<String,Object> data)
            throws FreshBooksException

Create a new task from the provided data. Makes a POST call against the task resource endpoint.

Parameters:

accountId - The alpha-numeric account id

data - Map of create data

Returns:

The created Task

Throws:

FreshBooksException - If the call is not successful

update

public Task update(String accountId,
 long taskId,
 Task data)
            throws FreshBooksException

Update the task with the corresponding id. Makes a PUT call against the task resource endpoint.

Parameters:

accountId - The alpha-numeric account id

taskId - Id of the resource to return

data - Task model with updated data

Returns:

The updated Task

Throws:

FreshBooksException - If the call is not successful

update

public Task update(String accountId,
 long taskId,
 Map<String,Object> data)
            throws FreshBooksException

Update the task with the corresponding id. Makes a PUT call against the task resource endpoint.

Parameters:

accountId - The alpha-numeric account id

taskId - Id of the resource to update

data - Map of data to change

Returns:

The updated Task

Throws:

FreshBooksException - If the call is not successful

delete

public Task delete(String accountId,
 long taskId)
            throws FreshBooksException

Delete the task with the corresponding id. Makes a PUT call against the task resource endpoint with a `vis_state` of deleted. Note: Most FreshBooks resources are soft-deleted,

Parameters:

accountId - The alpha-numeric account id

taskId - Id of the resource to update

Returns:

The deleted Task

Throws:

FreshBooksException - If the call is not successful

See Also:

• FreshBooks API - Active and Deleted Objects