Package com.cheetahdigital.rewards.core.api

Class RewardsAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.rewards.core.api.RewardsAPI

All Implemented Interfaces:

RestController

public class RewardsAPI
extends Controller

Cheetah Loyalty Rewards Module Rewards API is the API of the Rewards

Field Summary

Fields inherited from class com.cheetahdigital.corekit.models.module.Controller

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
RewardsAPI()

Method Summary

Modifier and Type	Method	Description
void	cancelRedemption(RewardParams queryParameters, RewardFields fieldParameters, ListenerModel<BaseModel<Redemption>,Redemption> listener)	Cancel a redemption
void	getAward(RewardParams params, boolean clearCache, ListenerModel<BaseModel<Award>,Award> listener)	Get the award
void	getAwards(RewardParams params, boolean clearCache, ListenerModel<BaseModel<Awards>,Awards> listener)	Get the awards
void	getFavoriteRewards(RewardParams parameters, boolean clearCache, ListenerModel<BaseModel<Rewards>,Rewards> listener)	Get the favorite rewards list
void	getRedemption(RewardParams parameters, boolean clearCache, ListenerModel<BaseModel<Redemption>,Redemption> listener)	Get the redemption
void	getRedemptions(RewardParams parameters, boolean clearCache, ListenerModel<BaseModel<Redemptions>,Redemptions> listener)	Get the list of redemptions
void	getReward(RewardParams parameters, boolean clearCache, ListenerModel<BaseModel<Reward>,Reward> listener)	Get the reward object
void	getRewardCategories(RewardParams parameters, boolean clearCache, ListenerModel<BaseModel<Categories>,Categories> listener)	Get the reward categories
void	getRewards(RewardParams parameters, boolean clearCache, ListenerModel<BaseModel<Rewards>,Rewards> listener)	Get the rewards list
void	redeemReward(RewardParams queryParameters, RewardFields fieldParameters, ListenerModel<BaseModel<Response>,Response> listener)	Redeem a Reward

Methods inherited from class com.cheetahdigital.corekit.models.module.Controller

createCache, createHttpClient, createRetrofitInterface, evictAllCache, getGsonConfiguration, getRestAdapter, getTimeoutConnectionInSeconds, getTimeoutSocketInSeconds, initialize, removeResponsesFromCache

Methods inherited from class java.lang.Object

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

Constructor Detail

RewardsAPI

public RewardsAPI()

Method Detail

getRewardCategories

public void getRewardCategories(RewardParams parameters,
                                boolean clearCache,
                                ListenerModel<BaseModel<Categories>,Categories> listener)

Get the reward categories

Parameters:

parameters - RewardParams query parameters

clearCache - boolean true to clear cache otherwise false

listener - callback for the API containing the response

getRewards

public void getRewards(RewardParams parameters,
                       boolean clearCache,
                       ListenerModel<BaseModel<Rewards>,Rewards> listener)

Get the rewards list

Parameters:

parameters - RewardParams query parameters

clearCache - boolean true to clear cache otherwise false

listener - callback for the API containing the response

getFavoriteRewards

public void getFavoriteRewards(RewardParams parameters,
                               boolean clearCache,
                               ListenerModel<BaseModel<Rewards>,Rewards> listener)

Get the favorite rewards list

Parameters:

parameters - RewardParams query parameters

clearCache - boolean true to clear cache otherwise false

listener - callback for the API containing the response

getReward

public void getReward(RewardParams parameters,
                      boolean clearCache,
                      ListenerModel<BaseModel<Reward>,Reward> listener)

Get the reward object

Parameters:

clearCache - boolean true to clear cache otherwise false

parameters - RewardParams query parameters

listener - callback for the API containing the response

getRedemptions

public void getRedemptions(RewardParams parameters,
                           boolean clearCache,
                           ListenerModel<BaseModel<Redemptions>,Redemptions> listener)

Get the list of redemptions

Parameters:

parameters - RewardParams query parameters

clearCache - boolean true to clear cache otherwise false

listener - callback for the API containing the response

getRedemption

public void getRedemption(RewardParams parameters,
                          boolean clearCache,
                          ListenerModel<BaseModel<Redemption>,Redemption> listener)

Get the redemption

Parameters:

parameters - RewardParams query parameters

clearCache - boolean true to clear cache otherwise false

listener - callback for the API containing the response

redeemReward

public void redeemReward(RewardParams queryParameters,
                         RewardFields fieldParameters,
                         ListenerModel<BaseModel<Response>,Response> listener)

Redeem a Reward

Parameters:

queryParameters - RewardParams query parameters

fieldParameters - RewardFields field parameters

listener - callback for the API containing the response

cancelRedemption

public void cancelRedemption(RewardParams queryParameters,
                             RewardFields fieldParameters,
                             ListenerModel<BaseModel<Redemption>,Redemption> listener)

Cancel a redemption

Parameters:

queryParameters - RewardParams query parameters

fieldParameters - RewardFields field parameters

listener - callback for the API containing the response

getAwards

public void getAwards(RewardParams params,
                      boolean clearCache,
                      ListenerModel<BaseModel<Awards>,Awards> listener)

Get the awards

Parameters:

params - RewardParams query parameters

clearCache - boolean true to clear cache otherwise false

listener - callback for the API containing the response

getAward

public void getAward(RewardParams params,
                     boolean clearCache,
                     ListenerModel<BaseModel<Award>,Award> listener)

Get the award

Parameters:

params - RewardParams query parameters

clearCache - boolean true to clear cache otherwise false

listener - callback for the API containing the response