public class People extends CreateSendBase
jerseyClient, urlEncodingScheme| Constructor and Description |
|---|
People(AuthenticationDetails auth,
String clientID)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
String |
add(PersonToAdd person)
Adds a person to the client.
|
void |
delete(String emailAddress)
Deletes the person with the specified email address from the client
|
Person |
details(String emailAddress)
Gets the details for the person with the given email address
|
String |
getClientID() |
void |
setClientID(String clientID) |
void |
update(String originalEmailAddress,
Person newDetails)
Updates the details for an existing person
|
refreshTokenpublic People(AuthenticationDetails auth, String clientID)
auth - The authentication details to use when making API calls.
May be either an OAuthAuthenticationDetails or
ApiKeyAuthenticationDetails instance.clientID - The Client ID to use when making API calls.public String getClientID()
public void setClientID(String clientID)
public String add(PersonToAdd person) throws CreateSendException
person - The person to add to the clientCreateSendException - Thrown when the API responds with HTTP Status >= 400public Person details(String emailAddress) throws CreateSendException
emailAddress - The email address to get the person details forCreateSendException - Thrown when the API responds with HTTP Status >= 400public void delete(String emailAddress) throws CreateSendException
emailAddress - The email address of the person to deleteCreateSendException - Thrown when the API responds with HTTP Status >= 400public void update(String originalEmailAddress, Person newDetails) throws CreateSendException
originalEmailAddress - The current email address of the existing personnewDetails - The new details for the person.CreateSendException - Thrown when the API responds with HTTP Status >= 400Copyright © 2013. All Rights Reserved.