Update Java docs

Author: jeremiahAI

app/src/main/java/com/flutterwave/rave_android/MainActivity.java

@@ -33,7 +33,6 @@
 import com.flutterwave.raveandroid.rave_presentation.card.CardPaymentManager;
 import com.flutterwave.raveandroid.rave_presentation.card.SavedCardsListener;
 import com.flutterwave.raveandroid.rave_presentation.data.AddressDetails;
-import com.flutterwave.raveandroid.rave_remote.responses.SaveCardResponse;
 import com.flutterwave.raveutils.verification.AVSVBVFragment;
 import com.flutterwave.raveutils.verification.OTPFragment;
 import com.flutterwave.raveutils.verification.PinFragment;
@@ -576,12 +575,12 @@ public void onSavedCardsLookupFailed(String message) {
     }
 
     @Override
-    public void onRemoveSavedCardRequestSuccessful() {
+    public void onDeleteSavedCardRequestSuccessful() {
 
     }
 
     @Override
-    public void onRemoveSavedCardRequestFailed(String message) {
+    public void onDeleteSavedCardRequestFailed(String message) {
 
     }
 
@@ -591,7 +590,7 @@ public void collectOtpForSaveCardCharge() {
     }
 
     @Override
-    public void onCardSaveSuccessful(SaveCardResponse response, String phoneNumber) {
+    public void onCardSaveSuccessful(String phoneNumber) {
 
     }
 

rave_presentation/src/main/java/com/flutterwave/raveandroid/rave_presentation/card/CardContract.java

@@ -109,7 +109,7 @@ interface CardInteractor {
          * When the payment is completed, the authentication page redirects to a {@link com.flutterwave.raveandroid.rave_java_commons.RaveConstants#RAVE_3DS_CALLBACK predefined url}
          * with the payment details appended to the url.
          * <p>
-         * You should override the webview client's {@link android.webkit.WebViewClient#shouldOverrideUrlLoading(WebView, WebResourceRequest)}  shouldOverrideUrlLoading}
+         * You should override the webview client's {@link android.webkit.WebViewClient#shouldOverrideUrlLoading(WebView, WebResourceRequest)  shouldOverrideUrlLoading}
          * function to check if the {@link WebResourceRequest#getUrl() url being loaded} contains the
          * {@link com.flutterwave.raveandroid.rave_java_commons.RaveConstants#RAVE_3DS_CALLBACK predefined redirect url}.
          * <p>

rave_presentation/src/main/java/com/flutterwave/raveandroid/rave_presentation/card/CardInteractorImpl.java

@@ -96,12 +96,12 @@ public void onSavedCardsLookupSuccessful(List<SavedCard> cards, String phoneNumb
 
     @Override
     public void onSavedCardRemoveSuccessful() {
-        savedCardsListener.onRemoveSavedCardRequestSuccessful();
+        savedCardsListener.onDeleteSavedCardRequestSuccessful();
     }
 
     @Override
     public void onSavedCardRemoveFailed(String message) {
-        savedCardsListener.onRemoveSavedCardRequestFailed(message);
+        savedCardsListener.onDeleteSavedCardRequestFailed(message);
     }
 
     @Override
@@ -127,7 +127,7 @@ public void collectOtpForSaveCardCharge(Payload payload) {
 
     @Override
     public void onCardSaveSuccessful(SaveCardResponse response, String phoneNumber) {
-        savedCardsListener.onCardSaveSuccessful(response, phoneNumber);
+        savedCardsListener.onCardSaveSuccessful(phoneNumber);
     }
 
     @Override

rave_presentation/src/main/java/com/flutterwave/raveandroid/rave_presentation/card/CardPaymentManager.java

@@ -101,11 +101,21 @@ public void setSavedCardsListener(SavedCardsListener listener) {
         interactor.setSavedCardsListener(listener);
     }
 
+    /**
+     * Fetch the saved cards associated with the user phone number (if available)
+     *
+     * @param showLoader If true, {@link CardPaymentCallback#showProgressIndicator(boolean)} will be used to indicate progress. Otherwise, request will be done silently
+     */
     public void fetchSavedCards(boolean showLoader) {
         paymentHandler.lookupSavedCards(manager.getPublicKey(), manager.getPhoneNumber(), showLoader);
     }
 
-    public void removeSavedCards(String cardhash) {
+    /**
+     * Delete a user's saved card.
+     *
+     * @param cardhash The {@link SavedCard#getCardHash() card hash} of the saved card to delete.
+     */
+    public void deleteSavedCard(String cardhash) {
         paymentHandler.deleteASavedCard(cardhash, manager.getPhoneNumber(), manager.getPublicKey());
     }
 

rave_presentation/src/main/java/com/flutterwave/raveandroid/rave_presentation/card/NullSavedCardsListener.java

@@ -17,12 +17,12 @@ public void onSavedCardsLookupFailed(String message) {
     }
 
     @Override
-    public void onRemoveSavedCardRequestSuccessful() {
+    public void onDeleteSavedCardRequestSuccessful() {
 
     }
 
     @Override
-    public void onRemoveSavedCardRequestFailed(String message) {
+    public void onDeleteSavedCardRequestFailed(String message) {
 
     }
 

rave_presentation/src/main/java/com/flutterwave/raveandroid/rave_presentation/card/SavedCardsListener.java

@@ -1,24 +1,56 @@
 package com.flutterwave.raveandroid.rave_presentation.card;
 
 import com.flutterwave.raveandroid.rave_core.models.SavedCard;
-import com.flutterwave.raveandroid.rave_remote.responses.SaveCardResponse;
 
 import java.util.List;
 
 public interface SavedCardsListener {
 
+    /**
+     * Called when the users saved cards list has been retrieved successfully.
+     *
+     * @param cards       A list of the user's saved cards
+     * @param phoneNumber The user phone number associated with these saved cards
+     */
     void onSavedCardsLookupSuccessful(List<SavedCard> cards, String phoneNumber);
 
+    /**
+     * Called when the saved card lookup fails.
+     *
+     * @param message Error message
+     */
     void onSavedCardsLookupFailed(String message);
 
-    void onRemoveSavedCardRequestSuccessful();
-
-    void onRemoveSavedCardRequestFailed(String message);
-
+    /**
+     * Called when a request to delete a card is successful.
+     */
+    void onDeleteSavedCardRequestSuccessful();
+
+    /**
+     * Called when a request to delete a card fails.
+     *
+     * @param message
+     */
+    void onDeleteSavedCardRequestFailed(String message);
+
+    /**
+     * Called when an OTP is needed to complete a card charge. The OTP should be collected from the
+     * user and submitted using {@link CardPaymentManager#submitOtp(String)}
+     */
     void collectOtpForSaveCardCharge();
 
-    void onCardSaveSuccessful(SaveCardResponse response, String phoneNumber);
-
+    /**
+     * Called when a card has been saved successfully.
+     *
+     * @param phoneNumber The user phone number against which the card was saved.
+     */
+    void onCardSaveSuccessful(String phoneNumber);
+
+    /**
+     * Called when a card  save request fails.
+     *
+     * @param message Error message
+     */
     void onCardSaveFailed(String message);
 
 }