com.empyr.api

Class EmpyrClient

java.lang.Object

com.empyr.api.EmpyrClient

public class EmpyrClient
extends Object

Main interface for interacting with the Empyr API. This class does not implement ALL the methods of the Empyr API. It is recommended that you subclass and extend the EmpyrClient with your own and add extension methods to the subclass.

Author:

jcuzens

Constructor Summary

Constructors

Constructor and Description
EmpyrClient(String clientId)
EmpyrClient(String clientId, String clientSecret)

Method Summary

Modifier and Type	Method and Description
void	addListener(ClientListener cl)
RestResponse<RestCard>	cardsAdd(String cardNumber, int expirationMonth, int expirationYear, String userToken)
RestResponse<RestCard>	cardsAdd(String cardNumber, int expirationMonth, int expirationYear, String userToken, Map<String,Object> additionalParams)
RestResponse<Boolean>	cardsExists(String cardNumber)
RestResponse<RestResults<RestCard>>	cardsList(String usertoken)
RestResponse<Boolean>	cardsRemove(String cardNumber, String email)
protected <T> RestResponse<T>	executeRequest(Request<T> r)
protected <T> RestResponse<T>	executeRequest(Request<T> r, int numRetries)
String	getAccessToken()
OAuthResponse	getAccessToken(String grantType, Map<String,Object> params)
protected OAuthResponse	getAccessToken(String clientId, String clientSecret, String grantType, Map<String,Object> params)
RestResponse<RestApplication>	getApplicationInfo()
RestResponse<Map<String,String>>	getCategories()
String	getClientId()
String	getClientSecret()
RestResponse<Map<String,String>>	getFeatures()
static EmpyrClient	getInstance() Convenience method for returning a previously initialized EmpyrClient.
static EmpyrClient	getInstance(String clientId) Initializes a main EmpyrClient instance with the provided client id.
static EmpyrClient	getInstance(String clientId, String clientSecret) Initializes a main EmpyrClient instance with the provided client id and client secret.
RestResponse<Map<String,String>>	getTopCategories()
String	getUserToken()
void	identify(String userToken) Identifies the user by providing the userToken.
void	removeListener(ClientListener cl)
void	setAccessToken(String accessToken)
void	setAutoRetryTimes(int autoRetryTimes)
void	setHost(String host)
RestResponse<RestUser>	uploadPhoto(FileUpload fu)
RestResponse<RestUser>	usersGet(String userId)
RestResponse<RestResults<RestTransaction>>	usersGetTransactions(Integer userId, String userToken)
String	usersLogin(String username, String password)
RestResponse<RestUser>	usersLookup(String email)
RestResponse<RestUser>	usersSignup(String firstname, String lastname, String email, String postalCode, String password, String referralCode, Map<String,Object> additionalParams) Signs up a user with the Empyr backend.
RestResponse<RestBusiness>	venuesAddPhoto(String venueId, String type, FileUpload fu)
RestResponse<RestBusiness>	venuesRemovePhoto(String venueId, Integer mediaId)
RestResponse<RestBusiness>	venuesSave(String businessToken, String name, Integer ownerId, String streetName, String postalCode, String category, String description)
RestResponse<RestBusiness>	venuesSave(String businessToken, String name, String phone, Integer ownerId, String streetName, String postalCode, String category, String description, String merchantId, String amexId, String parent, Double discount, Double referralPercent)

Methods inherited from class java.lang.Object

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

Constructor Detail

EmpyrClient

public EmpyrClient(String clientId)

EmpyrClient

public EmpyrClient(String clientId,
                   String clientSecret)

Method Detail

addListener

public void addListener(ClientListener cl)

removeListener

public void removeListener(ClientListener cl)

getClientId

public String getClientId()

Returns:

the clientId

getClientSecret

public String getClientSecret()

Returns:

the clientSecret

getUserToken

public String getUserToken()

Returns:

the userToken

getAccessToken

public String getAccessToken()

Returns:

the accessToken

setAccessToken

public void setAccessToken(String accessToken)

Parameters:

accessToken - the accessToken to set

setAutoRetryTimes

public void setAutoRetryTimes(int autoRetryTimes)

Parameters:

autoRetryTimes - the autoRetryTimes to set

setHost

public void setHost(String host)

Parameters:

host - Sets the host that we will attempt to connect to.

getInstance

public static EmpyrClient getInstance()

Convenience method for returning a previously initialized EmpyrClient.

Returns:

Return a previously initialized EmpyrClient.

getInstance

public static EmpyrClient getInstance(String clientId)

Initializes a main EmpyrClient instance with the provided client id. This is the most common way that the Empyr library would be used when in a mobile environment since the clientSecret should only be on the server side.

Parameters:

clientId - The client id of the application.

Returns:

Returns the EmpyrClient main instance.

getInstance

public static EmpyrClient getInstance(String clientId,
                                      String clientSecret)

Initializes a main EmpyrClient instance with the provided client id and client secret. Note that this would only be called from a controlled environment (e.g. server and not mobile) because of the exposure of the client secret.

Parameters:

clientId - The client id of the application.

clientSecret - The client secret of the application.

Returns:

Returns the EmpyrClient main instance.

identify

public void identify(String userToken)

Identifies the user by providing the userToken.

Parameters:

userToken - The userToken for the user.

usersSignup

public RestResponse<RestUser> usersSignup(String firstname,
                                          String lastname,
                                          String email,
                                          String postalCode,
                                          String password,
                                          String referralCode,
                                          Map<String,Object> additionalParams)

Signs up a user with the Empyr backend.

Parameters:

firstname - The first name of the user

lastname - The last name of the user

email - The email address or usertoken for the user. Needs to be in email form.

postalCode - The postal code of the user.

password - The password for the user.

referralCode - The referralcode the user signed up with.

additionalParams - Any additional params to pass to the API.

Returns:

usersGet

public RestResponse<RestUser> usersGet(String userId)

Parameters:

userId -

Returns:

uploadPhoto

public RestResponse<RestUser> uploadPhoto(FileUpload fu)

Returns:

usersLookup

public RestResponse<RestUser> usersLookup(String email)

Parameters:

email - The user to lookup by email or usertoken.

Returns:

usersGetTransactions

public RestResponse<RestResults<RestTransaction>> usersGetTransactions(Integer userId,
                                                                       String userToken)

Parameters:

userId -

userToken -

Returns:

usersLogin

public String usersLogin(String username,
                         String password)

getTopCategories

public RestResponse<Map<String,String>> getTopCategories()

getFeatures

public RestResponse<Map<String,String>> getFeatures()

cardsAdd

public RestResponse<RestCard> cardsAdd(String cardNumber,
                                       int expirationMonth,
                                       int expirationYear,
                                       String userToken)

cardsAdd

public RestResponse<RestCard> cardsAdd(String cardNumber,
                                       int expirationMonth,
                                       int expirationYear,
                                       String userToken,
                                       Map<String,Object> additionalParams)

cardsExists

public RestResponse<Boolean> cardsExists(String cardNumber)

Parameters:

cardNumber -

Returns:

cardsList

public RestResponse<RestResults<RestCard>> cardsList(String usertoken)

cardsRemove

public RestResponse<Boolean> cardsRemove(String cardNumber,
                                         String email)

getCategories

public RestResponse<Map<String,String>> getCategories()

getApplicationInfo

public RestResponse<RestApplication> getApplicationInfo()

venuesSave

public RestResponse<RestBusiness> venuesSave(String businessToken,
                                             String name,
                                             String phone,
                                             Integer ownerId,
                                             String streetName,
                                             String postalCode,
                                             String category,
                                             String description,
                                             String merchantId,
                                             String amexId,
                                             String parent,
                                             Double discount,
                                             Double referralPercent)

venuesSave

public RestResponse<RestBusiness> venuesSave(String businessToken,
                                             String name,
                                             Integer ownerId,
                                             String streetName,
                                             String postalCode,
                                             String category,
                                             String description)

venuesAddPhoto

public RestResponse<RestBusiness> venuesAddPhoto(String venueId,
                                                 String type,
                                                 FileUpload fu)

venuesRemovePhoto

public RestResponse<RestBusiness> venuesRemovePhoto(String venueId,
                                                    Integer mediaId)

executeRequest

protected <T> RestResponse<T> executeRequest(Request<T> r)

executeRequest

protected <T> RestResponse<T> executeRequest(Request<T> r,
                                             int numRetries)

getAccessToken

public OAuthResponse getAccessToken(String grantType,
                                    Map<String,Object> params)

getAccessToken

protected OAuthResponse getAccessToken(String clientId,
                                       String clientSecret,
                                       String grantType,
                                       Map<String,Object> params)