com.createsend

Class General

java.lang.Object

com.createsend.CreateSendBase

com.createsend.General

public class General
extends CreateSendBase

Provides methods for accessing all Account methods in the Campaign Monitor API

Field Summary

Fields inherited from class com.createsend.CreateSendBase

jerseyClient, urlEncodingScheme

Constructor Summary

Constructors

Constructor and Description
General(AuthenticationDetails auth) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Administrator[]	administrators()
static OAuthTokenDetails	exchangeToken(int clientID, String clientSecret, String redirectUri, String code) Exchange a provided OAuth code for an OAuth access token, 'expires in' value, and refresh token.
String	getAPIKey(String siteAddress, String username, String password) Gets the API Key to use with the given authentication data
static String	getAuthorizeUrl(int clientID, String redirectUri, String scope, String state) Get the authorization URL for your application, given the application's Client ID, Redirect URI, Scope, and optional State data.
BillingDetails	getBillingDetails()
ClientBasics[]	getClients()
String[]	getCountries()
String	getExternalSessionUrl(ExternalSessionOptions sessionOptions) Get a URL which initiates a new external session for the user with the given email.
String	getPrimaryContact()
Date	getSystemDate()
String[]	getTimezones()
void	setPrimaryContact(String emailAddress)

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

General

public General(AuthenticationDetails auth)

Constructor.

Parameters:

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

Method Detail

getAuthorizeUrl

public static String getAuthorizeUrl(int clientID,
                     String redirectUri,
                     String scope,
                     String state)

Get the authorization URL for your application, given the application's Client ID, Redirect URI, Scope, and optional State data.

Parameters:

clientID - The Client ID value for your application.

redirectUri - The Redirect URI value for your application.

scope - The permission scope your application is requesting.

state - Optional state data to include in the authorization URL.

Returns:

The authorization URL to which your application should redirect your users.

exchangeToken

public static OAuthTokenDetails exchangeToken(int clientID,
                              String clientSecret,
                              String redirectUri,
                              String code)
                                       throws CreateSendException

Exchange a provided OAuth code for an OAuth access token, 'expires in' value, and refresh token.

Parameters:

clientID - The Client ID value for your application.

clientSecret - The Client Secret value for your application.

redirectUri - The Redirect URI value for your application.

code - A unique code provided to your user which can be exchanged for an access token.

Returns:

An OAuthTokenDetails object containing the access token, 'expires in' value, and refresh token.

Throws:

CreateSendException

getAPIKey

public String getAPIKey(String siteAddress,
               String username,
               String password)
                 throws CreateSendException

Gets the API Key to use with the given authentication data

Parameters:

siteAddress - The create send site address for the account

username - The username used to login

password - The password of the account

Returns:

The API key for the specified authentication data

Throws:

CreateSendException

See Also:

Getting you API Key

getClients

public ClientBasics[] getClients()
                          throws CreateSendException

Returns:

An array of active clients in the create send account.

Throws:

CreateSendException

See Also:

Getting your clients

getBillingDetails

public BillingDetails getBillingDetails()
                                 throws CreateSendException

Returns:

Gets your billing details.

Throws:

CreateSendException

See Also:

Getting your billing details

getCountries

public String[] getCountries()
                      throws CreateSendException

Returns:

An array of valid countries for use in the Create Send API

Throws:

CreateSendException

See Also:

Getting valid countries

getTimezones

public String[] getTimezones()
                      throws CreateSendException

Returns:

An array of valid timezones for use in the Create Send API

Throws:

CreateSendException

See Also:

Getting valid timezones

getSystemDate

public Date getSystemDate()
                   throws CreateSendException

Returns:

The current date in the timezone of the authorised account

Throws:

CreateSendException

See Also:

Getting the current date

administrators

public Administrator[] administrators()
                               throws CreateSendException

Throws:

CreateSendException

getPrimaryContact

public String getPrimaryContact()
                         throws CreateSendException

Throws:

CreateSendException

setPrimaryContact

public void setPrimaryContact(String emailAddress)
                       throws CreateSendException

Throws:

CreateSendException

getExternalSessionUrl

public String getExternalSessionUrl(ExternalSessionOptions sessionOptions)
                             throws CreateSendException

Get a URL which initiates a new external session for the user with the given email. Full details: http://www.campaignmonitor.com/api/account/#single_sign_on

Parameters:

sessionOptions - The session options to use.

Returns:

The URL to initiate the external Campaign Monitor session.

Throws:

CreateSendException