Deprecate SDK public API

.github/workflows/SonarCloud.yml

@@ -10,21 +10,22 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Set up JDK 11
-        uses: actions/setup-java@v1
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
         with:
-          java-version: 11
+          distribution: 'temurin'
+          java-version: 17
       - name: Cache SonarCloud packages
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.sonar/cache
           key: ${{ runner.os }}-sonar
           restore-keys: ${{ runner.os }}-sonar
       - name: Cache Gradle packages
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.gradle/caches
           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}

paystack/src/main/java/co/paystack/android/Constants.kt

@@ -0,0 +1,4 @@
+package co.paystack.android
+
+const val DEPRECATION_MESSAGE =
+    "This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/"

paystack/src/main/java/co/paystack/android/Paystack.java

@@ -1,12 +1,15 @@
 package co.paystack.android;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
 import android.app.Activity;
 
 import co.paystack.android.exceptions.AuthenticationException;
 import co.paystack.android.exceptions.PaystackSdkNotInitializedException;
 import co.paystack.android.model.Charge;
 import co.paystack.android.model.PaystackModel;
 import co.paystack.android.utils.Utils;
+import kotlin.Deprecated;
 
 /**
  * This is the Paystack model class.\n
@@ -15,7 +18,9 @@
  * Instead, access the functionalities of this class via the {@link PaystackSdk}
  *
  * @author {[email protected]} on 9/16/15.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class Paystack extends PaystackModel {
 
     private String publicKey;
@@ -53,6 +58,10 @@ private void validatePublicKey(String publicKey) throws AuthenticationException
 
     }
 
+    /**
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+     */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     void chargeCard(Activity activity, Charge charge, TransactionCallback transactionCallback) {
         chargeCard(activity, charge, publicKey, transactionCallback);
     }
@@ -79,11 +88,34 @@ private void chargeCard(Activity activity, Charge charge, String publicKey, Tran
     private interface BaseCallback {
     }
 
+    /**
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+     */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     public interface TransactionCallback extends BaseCallback {
+        /**
+         * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+         */
+        @Deprecated(message = DEPRECATION_MESSAGE)
         void onSuccess(Transaction transaction);
+
+        /**
+         * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+         */
+        @Deprecated(message = DEPRECATION_MESSAGE)
         void beforeValidate(Transaction transaction);
+
+        /**
+         * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+         */
+        @Deprecated(message = DEPRECATION_MESSAGE)
         void showLoading(Boolean isProcessing);
+
+        /**
+         * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+         */
+        @Deprecated(message = DEPRECATION_MESSAGE)
         void onError(Throwable error, Transaction transaction);
     }
 
-}
+}

paystack/src/main/java/co/paystack/android/PaystackSdk.java

@@ -1,5 +1,7 @@
 package co.paystack.android;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
 import android.app.Activity;
 import android.content.Context;
 import android.content.pm.ApplicationInfo;
@@ -8,6 +10,7 @@
 import co.paystack.android.exceptions.PaystackSdkNotInitializedException;
 import co.paystack.android.model.Charge;
 import co.paystack.android.utils.Utils;
+import kotlin.Deprecated;
 
 /**
  * This is the overall paystack sdk manager class.
@@ -71,12 +74,18 @@ private static synchronized void initialize(Context applicationContext, SdkIniti
      * Initialize an sdk without a callback
      *
      * @param context - Application Context
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
      */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     public static synchronized void initialize(Context context) {
         initialize(context, null);
     }
 
-
+    /**
+     * @return Boolean - if the SDK has been initialised
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+     */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     public static boolean isSdkInitialized() {
         return sdkInitialized;
     }
@@ -86,7 +95,9 @@ public static boolean isSdkInitialized() {
      *
      * @return public key
      * @throws PaystackSdkNotInitializedException if the sdk hasn't been initialized
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
      */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     public static String getPublicKey() throws PaystackSdkNotInitializedException {
         //validate that the sdk has been initialized
         Utils.Validate.validateSdkInitialized();
@@ -98,7 +109,9 @@ public static String getPublicKey() throws PaystackSdkNotInitializedException {
      * Sets the public key
      *
      * @param publicKey - App Developer's public key
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
      */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     public static void setPublicKey(String publicKey) {
         PaystackSdk.publicKey = publicKey;
     }
@@ -137,6 +150,10 @@ private static void performChecks() {
         Utils.Validate.hasPublicKey();
     }
 
+    /**
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+     */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     public static void chargeCard(Activity activity, Charge charge, Paystack.TransactionCallback transactionCallback) {
         if (BuildConfig.DEBUG && (activity == null)) {
             throw new AssertionError("activity must not be null");
@@ -151,6 +168,10 @@ public static void chargeCard(Activity activity, Charge charge, Paystack.Transac
         paystack.chargeCard(activity, charge, transactionCallback);
     }
 
+    /**
+     * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+     */
+    @Deprecated(message = DEPRECATION_MESSAGE)
     public interface SdkInitializeCallback {
         void onInitialized();
     }

paystack/src/main/java/co/paystack/android/Transaction.java

@@ -1,7 +1,14 @@
 package co.paystack.android;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
 import co.paystack.android.api.model.TransactionApiResponse;
+import kotlin.Deprecated;
 
+/**
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+ */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class Transaction {
     private String id;
     private String reference;

paystack/src/main/java/co/paystack/android/TransactionManager.java

@@ -1,5 +1,6 @@
 package co.paystack.android;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
 import static co.paystack.android.Transaction.EMPTY_TRANSACTION;
 
 import android.app.Activity;
@@ -38,7 +39,12 @@
 import co.paystack.android.ui.PinSingleton;
 import co.paystack.android.utils.Crypto;
 import co.paystack.android.utils.StringUtils;
+import kotlin.Deprecated;
 
+/**
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+ */
+@Deprecated(message = DEPRECATION_MESSAGE)
 class TransactionManager {
 
     private static final String LOG_TAG = TransactionManager.class.getSimpleName();
@@ -95,7 +101,7 @@ void chargeCard(Activity activity, String publicKey, Charge charge, Paystack.Tra
         validateCardThenInitTransaction(publicKey, charge);
     }
 
-    private void validateCardThenInitTransaction(String publicKey, Charge charge) {
+    private void validateCardThenInitTransaction(String publicKey, Charge charge){
         try {
             if (charge.getCard() == null || !charge.getCard().isValid()) {
                 final CardSingleton si = CardSingleton.getInstance();
@@ -468,4 +474,4 @@ protected void onPostExecute(Address address) {
             }
         }
     }
-}
+}

paystack/src/main/java/co/paystack/android/api/ChargeApiCallback.kt

@@ -1,10 +1,15 @@
 package co.paystack.android.api
 
+import co.paystack.android.DEPRECATION_MESSAGE
 import co.paystack.android.api.model.ChargeResponse
 import co.paystack.android.api.request.ChargeParams
 
+/**
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
+ */
+@Deprecated(message = DEPRECATION_MESSAGE)
 interface ChargeApiCallback {
     fun onSuccess(params: ChargeParams, response: ChargeResponse)
 
     fun onError(exception: Throwable, reference: String?)
-}
+}

paystack/src/main/java/co/paystack/android/exceptions/AuthenticationException.java

@@ -1,8 +1,14 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
+import kotlin.Deprecated;
+
 /**
  * @author {[email protected]} on 9/16/15.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class AuthenticationException extends PaystackException {
     public AuthenticationException(String message) {
         super(message);
@@ -11,4 +17,4 @@ public AuthenticationException(String message) {
     public AuthenticationException(String message, Throwable e) {
         super(message, e);
     }
-}
+}

paystack/src/main/java/co/paystack/android/exceptions/CardException.java

@@ -1,8 +1,14 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
+import kotlin.Deprecated;
+
 /**
  * @author {[email protected]} on 9/13/15.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class CardException extends PaystackException {
 
     public CardException(String message) {

paystack/src/main/java/co/paystack/android/exceptions/ChargeException.java

@@ -1,8 +1,14 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
+import kotlin.Deprecated;
+
 /**
  * @author {[email protected]} on 9/25/15.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class ChargeException extends PaystackException {
     public ChargeException(String message) {
         super(message);

paystack/src/main/java/co/paystack/android/exceptions/ExpiredAccessCodeException.java

@@ -1,8 +1,14 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
+import kotlin.Deprecated;
+
 /**
  * @author {[email protected]} on 9/25/15.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class ExpiredAccessCodeException extends PaystackException {
     public ExpiredAccessCodeException(String message) {
         super(message);

paystack/src/main/java/co/paystack/android/exceptions/InvalidAmountException.java

@@ -1,8 +1,14 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
+import kotlin.Deprecated;
+
 /**
  * Created by i on 24/08/2016.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class InvalidAmountException extends PaystackException {
 
     private int amount;

paystack/src/main/java/co/paystack/android/exceptions/InvalidEmailException.java

@@ -1,8 +1,14 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
+import kotlin.Deprecated;
+
 /**
  * Created by i on 24/08/2016.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class InvalidEmailException extends PaystackException {
 
     private String email;

paystack/src/main/java/co/paystack/android/exceptions/PaystackActivityNotFoundException.java

@@ -1,8 +1,14 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
+import kotlin.Deprecated;
+
 /**
  * @author {[email protected]} on 9/22/15.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class PaystackActivityNotFoundException extends PaystackException {
     public PaystackActivityNotFoundException(String message) {
         super(message);

paystack/src/main/java/co/paystack/android/exceptions/PaystackException.java

@@ -1,12 +1,18 @@
 package co.paystack.android.exceptions;
 
+import static co.paystack.android.ConstantsKt.DEPRECATION_MESSAGE;
+
 import java.io.Serializable;
 
+import kotlin.Deprecated;
+
 /**
  * Base class for exceptions
  *
  * @author {[email protected]} on 9/13/15.
+ * @deprecated This SDK has been deprecated, Please refer to our new SDK: https://paystack.com/docs/developer-tools/android-sdk/
  */
+@Deprecated(message = DEPRECATION_MESSAGE)
 public class PaystackException extends RuntimeException implements Serializable {
 
     public PaystackException(String message) {