ch.aaap.harvestclient.api

Interface ClientContactsApi

All Superinterfaces:

Api.Create<ClientContact>, Api.Delete<ClientContact>, Api.Get<ClientContact>, Api.Simple<ClientContact>

All Known Implementing Classes:

ClientContactsApiImpl

public interface ClientContactsApi
extends Api.Simple<ClientContact>

See Also:

Client Contacts API on Harvest

Method Summary

Modifier and Type	Method and Description
ClientContact	create(ClientContact clientContactCreationInfo) Create a new ClientContact according to given creation information.
void	delete(Reference<ClientContact> clientContactReference) Delete an existing ClientContact.
ClientContact	get(Reference<ClientContact> clientContactReference)
List<ClientContact>	list(ClientContactFilter filter) Return a list of clientContacts, sorted by creation date, newest first.
Pagination<ClientContact>	list(ClientContactFilter filter, int page, int perPage) Return a list of clientContacts, sorted by creation date, newest first.
ClientContact	update(Reference<ClientContact> clientContactReference, ClientContactUpdateInfo toChange) Updates an existing ClientContact with the properties set in ClientContactUpdateInfo

Method Detail

list

List<ClientContact> list(ClientContactFilter filter)

Return a list of clientContacts, sorted by creation date, newest first. Use the filter object to filter the list.

Parameters:

filter - filtering options

Returns:

a (filtered) list of ClientContacts

list

Pagination<ClientContact> list(ClientContactFilter filter,
                               int page,
                               int perPage)

Return a list of clientContacts, 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:

filter - filtering options

page - the page number

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

Returns:

a (filtered) list of ClientContacts

get

ClientContact get(Reference<ClientContact> clientContactReference)

Specified by:

get in interface Api.Get<ClientContact>

Parameters:

clientContactReference - a reference to an existing ClientContact

Returns:

Return a full ClientContact object

create

ClientContact create(ClientContact clientContactCreationInfo)

Create a new ClientContact according to given creation information.

Specified by:

create in interface Api.Create<ClientContact>

Parameters:

clientContactCreationInfo - the creation options

Returns:

the newly created ClientContact

update

ClientContact update(Reference<ClientContact> clientContactReference,
                     ClientContactUpdateInfo toChange)

Updates an existing ClientContact with the properties set in ClientContactUpdateInfo

Parameters:

clientContactReference - the existing clientContact to be updated

toChange - the properties to be updated

Returns:

the updated ClientContact

delete

void delete(Reference<ClientContact> clientContactReference)

Delete an existing ClientContact.

Specified by:

delete in interface Api.Delete<ClientContact>

Parameters:

clientContactReference - a reference to an existing ClientContact to be deleted