ch.aaap.harvestclient.api

Interface EstimateItemCategoriesApi

All Superinterfaces:

Api.Create<EstimateItem.Category>, Api.Delete<EstimateItem.Category>, Api.Get<EstimateItem.Category>, Api.Simple<EstimateItem.Category>

All Known Implementing Classes:

EstimateItemCategoriesApiImpl

public interface EstimateItemCategoriesApi
extends Api.Simple<EstimateItem.Category>

See Also:

Estimate Item Categories API on Harvest

Method Summary

Modifier and Type	Method and Description
EstimateItem.Category	create(EstimateItem.Category creationInfo) Create a new EstimateItemCategory
void	delete(Reference<EstimateItem.Category> estimateItemCategoryReference) Delete an existing EstimateItemCategory.
EstimateItem.Category	get(Reference<EstimateItem.Category> estimateItemCategoryReference) Return an existing EstimateItemCategory.
List<EstimateItem.Category>	list(Instant updatedSince)
Pagination<EstimateItem.Category>	list(Instant updatedSince, int page, int perPage) Return a list of estimateItemCategories, sorted by creation date, newest first.
EstimateItem.Category	update(Reference<EstimateItem.Category> estimateItemCategoryReference, EstimateItem.Category toChange) Updates the specific estimateItemCategory by setting the values of the parameters passed.

Method Detail

list

List<EstimateItem.Category> list(@Nullable
                                 Instant updatedSince)

Parameters:

updatedSince - if set, only return categories updated since the given timestamp

Returns:

a list of all EstimateItemCategories in the account, sorted by creation date, newest first.

list

Pagination<EstimateItem.Category> list(@Nullable
                                       Instant updatedSince,
                                       int page,
                                       int perPage)

Return a list of estimateItemCategories, sorted by creation date, newest first. Use the filter object to filter the list. Page and perPage allow controlling how many results to return.

Parameters:

updatedSince - if set, only return categories updated since the given timestamp

page - the page number

perPage - how many results to return for one page. Max 100

Returns:

a (filtered) list of EstimateItemCategory

get

EstimateItem.Category get(Reference<EstimateItem.Category> estimateItemCategoryReference)

Return an existing EstimateItemCategory.

Specified by:

get in interface Api.Get<EstimateItem.Category>

Parameters:

estimateItemCategoryReference - a reference to an existing EstimateItemCategory

Returns:

the full EstimateItemCategory object

create

EstimateItem.Category create(EstimateItem.Category creationInfo)

Create a new EstimateItemCategory

Specified by:

create in interface Api.Create<EstimateItem.Category>

Parameters:

creationInfo - creation information

Returns:

the created EstimateItemCategory

update

EstimateItem.Category update(Reference<EstimateItem.Category> estimateItemCategoryReference,
                             EstimateItem.Category toChange)

Updates the specific estimateItemCategory by setting the values of the parameters passed. Any parameters not provided will be left unchanged

Parameters:

estimateItemCategoryReference - An existing EstimateItemCategory to be updated

toChange - the changes to be performed

Returns:

the updated EstimateItemCategory

delete

void delete(Reference<EstimateItem.Category> estimateItemCategoryReference)

Delete an existing EstimateItemCategory.

Specified by:

delete in interface Api.Delete<EstimateItem.Category>

Parameters:

estimateItemCategoryReference - a reference to the EstimateItemCategory to be deleted