add doc comments

Author: cleopatra27

documentation/.DS_Store

@@ -114,5 +114,6 @@
         <maven.compiler.target>19</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
+    
 
 </project>

pom.xml

@@ -9,7 +9,6 @@
 import static com.flutterwave.bean.Verb.*;
 
 public class Utility {
-
     public static String post(String url, String request, ChargeTypes chargeType, List<NameValuePair> nameValuePairs){
         return Optional.ofNullable(Client.runTransaction(
                 url,

src/main/java/com/flutterwave/client/Utility.java

@@ -7,8 +7,16 @@
 import static com.flutterwave.bean.ChargeTypes.DEFAULT;
 import static com.flutterwave.bean.Verb.POST;
 
+/**
+ * Handles sending metric data to assist F4B make the sdk and API better where needed.
+ * @author cleopatradouglas
+ */
 public class Metric {
 
+    /**
+     * sends the metric data needed
+     * @param type of charge
+     */
     public static void send(ChargeTypes type) {
         //validate public key is set in environment
         if (System.getProperty("publicKey") == null) {

src/main/java/com/flutterwave/metric/Metric.java

@@ -8,9 +8,16 @@
 import static com.flutterwave.bean.ChargeTypes.ACH_PAYMENT;
 
 /**
- * Handles ACH charge payments
+ * @author Cleopatra Douglas
+ * This payment method allows you to collect USD and ZAR payments via ACH
  */
 public class ACH extends Charge{
+
+    /**
+     * Handles ACH requests
+     * @param achRequest bean
+     * @return Response
+     */
     public Response runTransaction(ACHRequest achRequest){
         return runTransaction(achRequest.toString(), ACH_PAYMENT, false, Optional.empty());
     }

src/main/java/com/flutterwave/services/ACH.java

@@ -7,8 +7,17 @@
 
 import static com.flutterwave.bean.ChargeTypes.APPLEPAY;
 
+/**
+ * @author Cleopatra Douglas
+ * This payment method allows you to accept payments from your customers via Apple Pay.
+ */
 public class ApplePay extends Charge{
 
+    /**
+     * Handles ApplePay requests
+     * @param applePayRequest bean
+     * @return Response
+     */
     public Response runTransaction(ApplePayRequest applePayRequest){
         return runTransaction(applePayRequest.toString(), APPLEPAY, false, Optional.empty());
     }

src/main/java/com/flutterwave/services/ApplePay.java

@@ -7,7 +7,15 @@
 
 import static com.flutterwave.bean.ChargeTypes.BANK_TRANSFER;
 
+/**
+ * @author cleopatradouglas
+ */
 public class BanKTransfer extends Charge{
+    /**
+     * Handles bank transfer requests
+     * @param banKTransferRequest bean
+     * @return Response
+     */
     public Response runTransaction(BanKTransferRequest banKTransferRequest){
         return runTransaction(banKTransferRequest.toString(), BANK_TRANSFER, false, Optional.empty());
     }

src/main/java/com/flutterwave/services/BanKTransfer.java

@@ -8,8 +8,17 @@
 import static com.flutterwave.bean.ChargeTypes.DEBIT_NG_ACCOUNT;
 import static com.flutterwave.bean.ChargeTypes.DEBIT_UK_ACCOUNT;
 
+/**
+ * This payment method helps you charge Nigerian and UK bank accounts using Flutterwave.
+ * @author Cleopatra Douglas
+ */
 public class BankAccount extends Charge{
 
+    /**
+     * Handles bank account requests
+     * @param bankAccountRequest bean
+     * @return Response
+     */
     public Response runTransaction(BankAccountRequest bankAccountRequest){
         return runTransaction(bankAccountRequest.toString(),
                 bankAccountRequest.getCurrency().equals("NGN")? DEBIT_NG_ACCOUNT: DEBIT_UK_ACCOUNT,

src/main/java/com/flutterwave/services/BankAccount.java

@@ -12,11 +12,21 @@
  * @author Cleopatra Douglas
  */
 public class Banks {
+    /**
+     * Retrieves bank list
+     * @param country to retrieve
+     * @return ListResponse
+     */
     public ListResponse getBanks(String country){
         return Optional.of(get(getProperty("BANKS_BASE")+country, GET_BANKS, null))
                 .map(ListResponse::toListResponse).orElseThrow();
     }
 
+    /**
+     * Retrieves bank branches
+     * @param id for bank
+     * @return ListResponse
+     */
     public ListResponse getBankBranches(int id){
         return Optional.of(get(getProperty("BANKS_BASE")+id+"/branches", GET_BANKS, null))
                 .map(ListResponse::toListResponse).orElseThrow();

src/main/java/com/flutterwave/services/Banks.java

@@ -3,36 +3,65 @@
 import com.flutterwave.bean.BeneficiaryRequest;
 import com.flutterwave.bean.ListResponse;
 import com.flutterwave.bean.Response;
+import org.apache.http.NameValuePair;
+import org.apache.http.message.BasicNameValuePair;
 
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Optional;
 
 import static com.flutterwave.bean.ChargeTypes.BENEFICIARY;
 import static com.flutterwave.client.Utility.*;
 import static com.flutterwave.utility.Properties.getProperty;
 
 /**
+ * Manage Transfer Beneficiaries.
  * @author Cleopatra Douglas
  */
 public class Beneficiaries {
 
     private String ERROR = "Error processing request, please check logs";
 
+    /**
+     * Create beneficiaries for Transfers.
+     * @param beneficiaryRequest bean
+     * @return Response
+     */
     public Response runCreateBeneficiary(BeneficiaryRequest beneficiaryRequest){
         return Optional.of(post(getProperty("BENEFICIARY_BASE"), beneficiaryRequest.toString(),
                         BENEFICIARY, null))
                 .map(Response::toResponse).orElseThrow(() -> new RuntimeException(ERROR));
     }
 
-    public ListResponse runGetAllBeneficiaries(Optional<Integer> id){
-        return Optional.of(get(getProperty("BENEFICIARY_BASE"), BENEFICIARY, null))
+    /**
+     * Get all beneficiaries saves for Transfers.
+     * @param page This is the page number to retrieve e.g. setting 1 retrieves the first page
+     * @return ListResponse
+     */
+    public ListResponse runGetAllBeneficiaries(Optional<Integer> page){
+        List<NameValuePair> nameValuePairs = new ArrayList<>();
+        page.ifPresent(s -> nameValuePairs.add(new BasicNameValuePair("page", s.toString())));
+        return Optional.of(get(getProperty("BENEFICIARY_BASE"), BENEFICIARY, nameValuePairs))
                 .map(ListResponse::toListResponse).orElseThrow(() -> new RuntimeException(ERROR));
     }
 
+    /**
+     * Get all details for a particular beneficiary.
+     * @param id int This is the unique identifier for the beneficiary you intend to fetch.
+     *           It is returned in the call to create a beneficiary as data.id
+     * @return Response
+     */
     public Response runGetBeneficiary(int id){
         return Optional.of(get(getProperty("BENEFICIARY_BASE") +"/" + id, BENEFICIARY, null))
                 .map(Response::toResponse).orElseThrow(() -> new RuntimeException(ERROR));
     }
 
+    /**
+     * Remove a beneficiary from your beneficiary list.
+     * @param id int This is the unique identifier for the beneficiary you intend to fetch.
+     *           It is returned in the call to create a beneficiary as data.id
+     * @return Response
+     */
     public Response runDeleteBeneficiary(int id){
         return Optional.of(delete(getProperty("BENEFICIARY_BASE") +"/" + id, BENEFICIARY, null))
                 .map(Response::toResponse).orElseThrow(() -> new RuntimeException(ERROR));