ch.aaap.harvestclient.core

Class Harvest

Object

ch.aaap.harvestclient.core.Harvest

public class Harvest
extends Object

Main client class. All API access starts from this.

Note for developers: Harvest datatype mappings: boolean -> Boolean string -> String integer-> Long decimal -> Double date -> LocalDate datetime -> Instant time -> LocalTime, but depends on harvest config for parsing array -> List<T> object -> Object

Constructor Summary

Constructors

Constructor and Description
Harvest()
Harvest(com.typesafe.config.Config config) Check reference.conf under src/main/resources for the default configuration.

Method Summary

Modifier and Type	Method and Description
ClientContactsApi	clientContacts()
ClientsApi	clients()
CompanyApi	company()
EstimateItemCategoriesApi	estimateItemCategories()
EstimateMessagesApi	estimateMessages()
EstimatesApi	estimates()
ExpenseCategoriesApi	expenseCategories()
ExpensesApi	expenses()
String	getAccountId()
String	getAuthToken()
String	getBaseUrl()
CurrencyConfiguration	getCurrencyConfiguration()
ZoneId	getSelfTimezone()
TimezoneConfiguration	getTimezoneConfiguration()
String	getUserAgent()
InvoiceItemCategoriesApi	invoiceItemCategories()
InvoiceMessagesApi	invoiceMessages()
InvoicePaymentsApi	invoicePayments()
InvoicesApi	invoices()
ProjectAssignmentsApi	projectAssignments()
ProjectsApi	projects()
RolesApi	roles()
TaskAssignmentsApi	taskAssignments()
TasksApi	tasks()
TimesheetsApi	timesheets()
UserAssignmentsApi	userAssignments()
UsersApi	users()

Methods inherited from class Object

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

Constructor Detail

Harvest

public Harvest()

Harvest

public Harvest(com.typesafe.config.Config config)

Check reference.conf under src/main/resources for the default configuration. You can either create a application.conf file that you put in your own src/main/resources that will override the settings, or build a Config object from scratch with ConfigFactory

Example:

 // use application.conf under src/main/resources
 Harvest harvest = new Harvest();

 // start from defaults
 Config config = ConfigFactory.defaultReference();
 config = config.withValue("harvest.auth.token", ConfigValueFactory.fromAnyRef("YOUR_TOKEN"));
 config = config.withValue("harvest.auth.accountId", ConfigValueFactory.fromAnyRef("YOUR_ACCOUNT_ID"));
 harvest = new Harvest(config)
 

Parameters:

config - the configuration to be used for this client.

Throws:

HarvestHttpException - if we fail to get the Company object (to configure the clock format)

See Also:

Config library on Github, Harvest auth token page

Method Detail

getSelfTimezone

public ZoneId getSelfTimezone()

Returns:

the ZoneId of the currently authenticated User

timesheets

public TimesheetsApi timesheets()

users

public UsersApi users()

userAssignments

public UserAssignmentsApi userAssignments()

company

public CompanyApi company()

roles

public RolesApi roles()

projectAssignments

public ProjectAssignmentsApi projectAssignments()

projects

public ProjectsApi projects()

taskAssignments

public TaskAssignmentsApi taskAssignments()

tasks

public TasksApi tasks()

clients

public ClientsApi clients()

clientContacts

public ClientContactsApi clientContacts()

estimates

public EstimatesApi estimates()

estimateItemCategories

public EstimateItemCategoriesApi estimateItemCategories()

estimateMessages

public EstimateMessagesApi estimateMessages()

invoiceItemCategories

public InvoiceItemCategoriesApi invoiceItemCategories()

invoices

public InvoicesApi invoices()

invoiceMessages

public InvoiceMessagesApi invoiceMessages()

invoicePayments

public InvoicePaymentsApi invoicePayments()

expenseCategories

public ExpenseCategoriesApi expenseCategories()

expenses

public ExpensesApi expenses()

getBaseUrl

public String getBaseUrl()

getAuthToken

public String getAuthToken()

getAccountId

public String getAccountId()

getUserAgent

public String getUserAgent()

getTimezoneConfiguration

public TimezoneConfiguration getTimezoneConfiguration()

getCurrencyConfiguration

public CurrencyConfiguration getCurrencyConfiguration()