Package com.cheetahdigital.giftcards.core.api

Class GiftcardsAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.giftcards.core.api.GiftcardsAPI

All Implemented Interfaces:

RestController

public class GiftcardsAPI
extends Controller

Class for setting the query parameters of Giftcards API. All Nullable parameters means you can remove the parameter by passing a null value.

Field Summary

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

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
GiftcardsAPI()

Method Summary

Modifier and Type	Method	Description
void	getClasses(GiftcardParams queryParams, boolean clearCache, ListenerModel<BaseModel<CardClasses>,CardClasses> listener)	Gets the list of giftcard classes
void	getGiftcard(GiftcardParams queryParams, boolean clearCache, ListenerModel<BaseModel<Giftcard>,Giftcard> listener)	Gets the details of the gift card.
void	getGiftcards(GiftcardParams queryParams, boolean clearCache, ListenerModel<BaseModel<Giftcards>,Giftcards> listener)	Gets the list of gift cards
void	getGiftcardsClientToken(GiftcardParams queryParams, boolean clearCache, ListenerModel<BaseModel<ClientToken>,ClientToken> listener)	Gets the client token required for the Braintree SDK
void	getTransactions(GiftcardParams queryParams, boolean clearCache, ListenerModel<BaseModel<Transactions>,Transactions> listener)	Gets the history of activities.
void	linkGiftcard(GiftcardParams queryParams, GiftcardFields fieldParams, ListenerModel<BaseModel<Giftcard>,Giftcard> listener)	Add a gift card to the account of the member Remember to set the following: card number using BaseParams.setId(String) pin using GiftcardFields.setPin(String)
void	purchaseGiftcard(GiftcardParams queryParams, GiftcardFields fieldParams, ListenerModel<BaseModel<PurchaseResponse>,PurchaseResponse> listener)	Purchase a digital gift card Remember to set the following: amount using GiftcardFields.setAmount(Float) payment method nonce using GiftcardFields.setPaymentMethodNonce(String)
void	reloadGiftcard(GiftcardParams queryParams, GiftcardFields fieldParams, ListenerModel<BaseModel<GiftcardReload>,GiftcardReload> listener)	Reload a gift card with a specified amount.
void	unlinkGiftcard(GiftcardParams queryParams, ListenerModel<BaseModel<Giftcard>,Giftcard> listener)	Remove a gift card from the account of the member.
void	updateGiftcard(GiftcardParams queryParams, GiftcardFields fieldParams, ListenerModel<BaseModel<Giftcard>,Giftcard> listener)	Update details of a specific giftcard.

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

GiftcardsAPI

public GiftcardsAPI()

Method Detail

getGiftcardsClientToken

public void getGiftcardsClientToken(GiftcardParams queryParams,
                                    boolean clearCache,
                                    ListenerModel<BaseModel<ClientToken>,ClientToken> listener)

Gets the client token required for the Braintree SDK

Parameters:

queryParams - the GiftcardParams for Giftcards API

clearCache - clear previously stored cache

listener - callback to handle the results

getGiftcards

public void getGiftcards(GiftcardParams queryParams,
                         boolean clearCache,
                         ListenerModel<BaseModel<Giftcards>,Giftcards> listener)

Gets the list of gift cards

Parameters:

queryParams - the GiftcardParams for Giftcards API

clearCache - clear previously stored cache

listener - callback to handle the results

getGiftcard

public void getGiftcard(GiftcardParams queryParams,
                        boolean clearCache,
                        ListenerModel<BaseModel<Giftcard>,Giftcard> listener)

Gets the details of the gift card. Remember to set the card number by BaseParams.setId(String)

Parameters:

queryParams - the GiftcardParams for Giftcards API

clearCache - clear previously stored cache

listener - callback to handle the results

reloadGiftcard

public void reloadGiftcard(GiftcardParams queryParams,
                           GiftcardFields fieldParams,
                           ListenerModel<BaseModel<GiftcardReload>,GiftcardReload> listener)

Reload a gift card with a specified amount. Remember to set the following:

• card number using BaseParams.setId(String)
• amount using GiftcardFields.setAmount(Float)
• payment method nonce using GiftcardFields.setPaymentMethodNonce(String)

Parameters:

queryParams - the GiftcardParams for Giftcards API

fieldParams - the GiftcardFields for Giftcards API

listener - callback to handle the results

purchaseGiftcard

public void purchaseGiftcard(GiftcardParams queryParams,
                             GiftcardFields fieldParams,
                             ListenerModel<BaseModel<PurchaseResponse>,PurchaseResponse> listener)

Purchase a digital gift card Remember to set the following:

• amount using GiftcardFields.setAmount(Float)
• payment method nonce using GiftcardFields.setPaymentMethodNonce(String)

Parameters:

queryParams - the GiftcardParams for Giftcards API

fieldParams - the GiftcardFields for Giftcards API

listener - callback to handle the results

linkGiftcard

public void linkGiftcard(GiftcardParams queryParams,
                         GiftcardFields fieldParams,
                         ListenerModel<BaseModel<Giftcard>,Giftcard> listener)

Add a gift card to the account of the member Remember to set the following:

• card number using BaseParams.setId(String)
• pin using GiftcardFields.setPin(String)

Parameters:

queryParams - the GiftcardParams for Giftcards API

fieldParams - the GiftcardFields for Giftcards API

listener - callback to handle the results

unlinkGiftcard

public void unlinkGiftcard(GiftcardParams queryParams,
                           ListenerModel<BaseModel<Giftcard>,Giftcard> listener)

Remove a gift card from the account of the member. Remember to set the card number by BaseParams.setId(String)

Parameters:

queryParams - the GiftcardParams for Giftcards API

listener - callback to handle the results

getTransactions

public void getTransactions(GiftcardParams queryParams,
                            boolean clearCache,
                            ListenerModel<BaseModel<Transactions>,Transactions> listener)

Gets the history of activities. Remember to set the card number by BaseParams.setId(String)

Parameters:

queryParams - the GiftcardParams for Giftcards API

clearCache - clear previously stored cache

listener - callback to handle the results

updateGiftcard

public void updateGiftcard(GiftcardParams queryParams,
                           GiftcardFields fieldParams,
                           ListenerModel<BaseModel<Giftcard>,Giftcard> listener)

Update details of a specific giftcard. Remember to set the card number by BaseParams.setId(String) When setting auto-reload to true, remember to set the following:

• nonce using GiftcardFields.setPaymentMethodNonce(String)
• auto-reload using GiftcardFields.setIsAutoReload(Boolean)
• threshold amount using GiftcardFields.setReloadThreshold(String)
• reload amount using GiftcardFields.setReloadAmount(String)

Parameters:

queryParams - the GiftcardParams for Giftcards API

fieldParams - the GiftcardFields for Giftcards API

listener - callback to handle the results

getClasses

public void getClasses(GiftcardParams queryParams,
                       boolean clearCache,
                       ListenerModel<BaseModel<CardClasses>,CardClasses> listener)

Gets the list of giftcard classes

Parameters:

queryParams - the GiftcardParams for Giftcards API

clearCache - clear previously stored cache

listener - callback to handle the results