Package ch.aaap.harvestclient.impl
Class ClientContactsApiImpl
Object
ch.aaap.harvestclient.impl.ClientContactsApiImpl
- All Implemented Interfaces:
Api.Create<ClientContact>
,Api.Delete<ClientContact>
,Api.Get<ClientContact>
,Api.Simple<ClientContact>
,ClientContactsApi
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(ClientContact clientContactCreationInfo) Create a new ClientContact according to given creation information.void
delete
(Reference<ClientContact> clientContactReference) Delete an existing ClientContact.get
(Reference<ClientContact> clientContactReference) list
(ClientContactFilter filter) Return a list of clientContacts, sorted by creation date, newest first.list
(ClientContactFilter filter, int page, int perPage) Return a list of clientContacts, sorted by creation date, newest first.update
(Reference<ClientContact> clientContactReference, ClientContactUpdateInfo toChange) Updates an existing ClientContact with the properties set in ClientContactUpdateInfo
-
Constructor Details
-
ClientContactsApiImpl
-
-
Method Details
-
list
Description copied from interface:ClientContactsApi
Return a list of clientContacts, sorted by creation date, newest first. Use the filter object to filter the list.- Specified by:
list
in interfaceClientContactsApi
- Parameters:
filter
- filtering options- Returns:
- a (filtered) list of ClientContacts
-
list
Description copied from interface:ClientContactsApi
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.- Specified by:
list
in interfaceClientContactsApi
- Parameters:
filter
- filtering optionspage
- the page numberperPage
- how many results to return for one page. Max 100- Returns:
- a (filtered) list of ClientContacts
-
get
- Specified by:
get
in interfaceApi.Get<ClientContact>
- Specified by:
get
in interfaceClientContactsApi
- Parameters:
clientContactReference
- a reference to an existing ClientContact- Returns:
- Return a full ClientContact object
-
create
Description copied from interface:ClientContactsApi
Create a new ClientContact according to given creation information.- Specified by:
create
in interfaceApi.Create<ClientContact>
- Specified by:
create
in interfaceClientContactsApi
- Parameters:
clientContactCreationInfo
- the creation options- Returns:
- the newly created ClientContact
-
update
public ClientContact update(Reference<ClientContact> clientContactReference, ClientContactUpdateInfo toChange) Description copied from interface:ClientContactsApi
Updates an existing ClientContact with the properties set in ClientContactUpdateInfo- Specified by:
update
in interfaceClientContactsApi
- Parameters:
clientContactReference
- the existing clientContact to be updatedtoChange
- the properties to be updated- Returns:
- the updated ClientContact
-
delete
Description copied from interface:ClientContactsApi
Delete an existing ClientContact.- Specified by:
delete
in interfaceApi.Delete<ClientContact>
- Specified by:
delete
in interfaceClientContactsApi
- Parameters:
clientContactReference
- a reference to an existing ClientContact to be deleted
-