ch.aaap.harvestclient.api

Interface ClientsApi

All Known Implementing Classes:

ClientsApiImpl

public interface ClientsApi

Method Summary

Modifier and Type	Method and Description
Client	create(ClientCreationInfo creationInfo) Create a new Client
void	delete(Reference<Client> clientReference) Delete an existing Client.
Client	get(Reference<Client> clientReference) Return an existing Client.
List<Client>	list(ClientFilter filter)
Client	update(Reference<Client> clientReference, ClientUpdateInfo toChange) Updates the specific client by setting the values of the parameters passed.

Method Detail

list

List<Client> list(ClientFilter filter)

Parameters:

filter - filtering options

Returns:

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

get

Client get(Reference<Client> clientReference)

Return an existing Client.

Parameters:

clientReference - a reference to an existing Client

Returns:

the full Client object

create

Client create(ClientCreationInfo creationInfo)

Create a new Client

Parameters:

creationInfo - creation information

Returns:

the created Client

update

Client update(Reference<Client> clientReference,
              ClientUpdateInfo toChange)

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

Parameters:

clientReference - An existing Client to be updated

toChange - the changes to be performed

Returns:

the updated Client

delete

void delete(Reference<Client> clientReference)

Delete an existing Client.

Parameters:

clientReference - a reference to the Client to be deleted