com.createsend

Class Administrators

java.lang.Object

com.createsend.CreateSendBase

com.createsend.Administrators

public class Administrators
extends CreateSendBase

Field Summary

Fields inherited from class com.createsend.CreateSendBase

jerseyClient, urlEncodingScheme

Constructor Summary

Constructors

Constructor and Description
Administrators(AuthenticationDetails auth) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	add(Administrator person) Adds an administrator to the account.
void	delete(String emailAddress) Deletes the administrator with the specified email address from this account
Administrator	details(String emailAddress) Gets the details for the administrator with the given email address
void	update(String originalEmailAddress, Administrator newDetails) Updates the details for an existing administrator

Methods inherited from class com.createsend.CreateSendBase

refreshToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Administrators

public Administrators(AuthenticationDetails auth)

Constructor.

Parameters:

auth - The authentication details to use when making API calls. May be either an OAuthAuthenticationDetails or ApiKeyAuthenticationDetails instance.

Method Detail

add

public String add(Administrator person)
           throws CreateSendException

Adds an administrator to the account.

Parameters:

person - The administrator to add to the account

Returns:

The email address of the newly added administrator

Throws:

CreateSendException - Thrown when the API responds with HTTP Status >= 400

See Also:

Adding a subscriber

details

public Administrator details(String emailAddress)
                      throws CreateSendException

Gets the details for the administrator with the given email address

Parameters:

emailAddress - The email address of the administrator to get the details for

Returns:

The details of the person

Throws:

CreateSendException - Thrown when the API responds with HTTP Status >= 400

See Also:

Getting subscriber details

delete

public void delete(String emailAddress)
            throws CreateSendException

Deletes the administrator with the specified email address from this account

Parameters:

emailAddress - The email address of the administrator to delete

Throws:

CreateSendException - Thrown when the API responds with HTTP Status >= 400

See Also:

Deleting a subscriber

update

public void update(String originalEmailAddress,
          Administrator newDetails)
            throws CreateSendException

Updates the details for an existing administrator

Parameters:

originalEmailAddress - The current email address of the existing administrator

newDetails - The new details for the administrator.

Throws:

CreateSendException - Thrown when the API responds with HTTP Status >= 400

See Also:

Updating a subscriber