Package 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
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(EstimateItem.Category creationInfo) Create a new EstimateItemCategoryvoid
delete
(Reference<EstimateItem.Category> estimateItemCategoryReference) Delete an existing EstimateItemCategory.get
(Reference<EstimateItem.Category> estimateItemCategoryReference) Return an existing EstimateItemCategory.Return a list of estimateItemCategories, sorted by creation date, newest first.update
(Reference<EstimateItem.Category> estimateItemCategoryReference, EstimateItem.Category toChange) Updates the specific estimateItemCategory by setting the values of the parameters passed.
-
Method Details
-
list
- 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
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 timestamppage
- the page numberperPage
- how many results to return for one page. Max 100- Returns:
- a (filtered) list of EstimateItemCategory
-
get
Return an existing EstimateItemCategory.- Specified by:
get
in interfaceApi.Get<EstimateItem.Category>
- Parameters:
estimateItemCategoryReference
- a reference to an existing EstimateItemCategory- Returns:
- the full EstimateItemCategory object
-
create
Create a new EstimateItemCategory- Specified by:
create
in interfaceApi.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 updatedtoChange
- the changes to be performed- Returns:
- the updated EstimateItemCategory
-
delete
Delete an existing EstimateItemCategory.- Specified by:
delete
in interfaceApi.Delete<EstimateItem.Category>
- Parameters:
estimateItemCategoryReference
- a reference to the EstimateItemCategory to be deleted
-