Merge pull request #166 from mwarzybok-sumoheavy/feature/SP-28

SP-28 Add JavaDoc to Payout model classes

Author: bobbrodie

src/main/java/com/bitpay/sdk/model/Payout/Payout.java

@@ -10,6 +10,9 @@
 
 import java.util.List;
 
+/**
+ * The type Payout instruction.
+ */
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class PayoutInstruction {
     private Double _amount;
@@ -56,67 +59,159 @@ public PayoutInstruction(Double amount, int method, String methodValue) throws P
         }
     }
 
+    /**
+     * Gets the payout amount in the requested currency. The minimum amount per instruction is $5 USD equivalent.
+     *
+     * @return the amount
+     */
     @JsonProperty("amount")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public Double getAmount() {
         return _amount;
     }
 
+    /**
+     * Sets the payout amount in the requested currency. The minimum amount per instruction is $5 USD equivalent.
+     *
+     * @param amount the amount
+     */
     @JsonProperty("amount")
     public void setAmount(Double amount) {
         this._amount = amount;
     }
 
+    /**
+     * Gets email address of an active recipient.
+     * Note: In the future, BitPay may allow Recipients to update the email address tied to their personal account.
+     * BitPay encourages the use of recipientId or shopperId when programatically creating payouts.
+     *
+     * @return the email
+     */
     @JsonProperty("email")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public String getEmail() {
         return _email;
     }
 
+    /**
+     * Sets email address of an active recipient.
+     * Note: In the future, BitPay may allow Recipients to update the email address tied to their personal account.
+     * BitPay encourages the use of recipientId or shopperId when programatically creating payouts.
+     *
+     * @param email the email
+     */
     @JsonProperty("email")
     public void setEmail(String email) {
         this._email = email;
     }
 
+    /**
+     * Gets Bitpay recipient id of an active recipient,
+     * assigned by BitPay for a given recipient email during the onboarding process (see Recipients below).
+     *
+     * @return the recipient id
+     * @see <a href="https://bitpay.com/api/#rest-api-resources-recipients">Recipients</a>
+     */
     @JsonProperty("recipientId")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public String getRecipientId() {
         return _recipientId;
     }
 
+    /**
+     * Sets Bitpay recipient id of an active recipient,
+     * assigned by BitPay for a given recipient email during the onboarding process (see Recipients below).
+     *
+     * @param recipientId the recipient id
+     * @see <a href="https://bitpay.com/api/#rest-api-resources-recipients">Recipients</a>
+     */
     @JsonProperty("recipientId")
     public void setRecipientId(String recipientId) {
         this._recipientId = recipientId;
     }
 
+    /**
+     * Gets shopper id.
+     * <p>
+     *  This is the unique id assigned by BitPay if the shopper used their personal BitPay account to authenticate
+     *   pay an invoice. For customers signing up for a brand new BitPay personal account, this id will only
+     *  be created as part of the payout onboarding.
+     * </p>
+     * <p>
+     *  The same field would also be available on paid invoices if the customer signed in with their
+     *  BitPay personal account before completing the payment.
+     *  This can allow merchants to monitor the activity of a customer (deposits and payouts).
+     * </p>
+     *
+     * @return the shopper id
+     */
     @JsonProperty("shopperId")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public String getShopperId() {
         return _shopperId;
     }
 
+    /**
+     * Sets shopper id.
+     * <p>
+     *  This is the unique id assigned by BitPay if the shopper used their personal BitPay account to authenticate
+     *   pay an invoice. For customers signing up for a brand new BitPay personal account, this id will only
+     *  be created as part of the payout onboarding.
+     * </p>
+     * <p>
+     *  The same field would also be available on paid invoices if the customer signed in with their
+     *  BitPay personal account before completing the payment.
+     *  This can allow merchants to monitor the activity of a customer (deposits and payouts).
+     * </p>
+     *
+     * @param shopperId the shopper id
+     */
     @JsonProperty("shopperId")
     public void setShopperId(String shopperId) {
         this._shopperId = shopperId;
     }
 
+    /**
+     * Gets label.
+     * For merchant use, pass through - can be the customer name or unique payout reference assigned by the merchant
+     * to the recipient.
+     *
+     * @return the label
+     */
     @JsonProperty("label")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public String getLabel() {
         return _label;
     }
 
+    /**
+     * Sets label.
+     * For merchant use, pass through - can be the customer name or unique payout reference assigned by the merchant
+     * to the recipient.
+     *
+     * @param label the label
+     */
     @JsonProperty("label")
     public void setLabel(String label) {
         this._label = label;
     }
 
+    /**
+     * Gets wallet provider.
+     *
+     * @return the wallet provider
+     */
     @JsonProperty("walletProvider")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public String getWalletProvider() {
         return _walletProvider;
     }
 
+    /**
+     * Sets wallet provider.
+     *
+     * @param walletProvider the wallet provider
+     */
     @JsonProperty("walletProvider")
     public void setWalletProvider(String walletProvider) {
         this._walletProvider = walletProvider;
@@ -125,53 +220,133 @@ public void setWalletProvider(String walletProvider) {
     // Response fields
     //
 
+    /**
+     * Gets id.
+     *
+     * @return the id
+     */
     @JsonIgnore
     public String getId() {
         return _id;
     }
 
+    /**
+     * Sets id.
+     *
+     * @param id the id
+     */
     @JsonProperty("id")
     public void setId(String id) {
         this._id = id;
     }
 
+    /**
+     * Gets btc.
+     *
+     * @return the btc
+     */
     @JsonIgnore
     public PayoutInstructionBtcSummary getBtc() {
         return _btc;
     }
 
+    /**
+     * Sets btc.
+     *
+     * @param btc the btc
+     */
     @JsonProperty("btc")
     @JsonDeserialize(using = PayoutInstructionBtcSummaryDeserializer.class)
     public void setBtc(PayoutInstructionBtcSummary btc) {
         this._btc = btc;
     }
 
+    /**
+     * Gets the cryptocurrency transactions details for the executed payout.
+     *
+     * @return the transactions
+     */
     @JsonIgnore
     public List<PayoutInstructionTransaction> getTransactions() {
         return _transactions;
     }
 
+    /**
+     * Sets the cryptocurrency transactions details for the executed payout.
+     *
+     * @param transactions the transactions
+     */
     @JsonProperty("transactions")
     public void setTransactions(List<PayoutInstructionTransaction> transactions) {
         this._transactions = transactions;
     }
 
+    /**
+     * Gets status, the possible values are:
+     * <ul>
+     *     <li>new - initial status when the payout batch is created</li>
+     *     <li>funded - if there are enough funds available on the merchant account,
+     *      the payout batches are set to funded. This happens at the daily cutoff time for payout processing,
+     *      e.g. 2pm and 9pm UTC
+     *     </li>
+     *     <li>processing - the payout batches switch to this status whenever the corresponding cryptocurrency
+     *      transactions are broadcasted by BitPay
+     *     </li>
+     *     <li>complete - the payout batches are marked as complete when the cryptocurrency transaction has reached
+     *      the typical target confirmation for the corresponding asset. For instance,
+     *      6 confirmations for a bitcoin transaction.
+     *     </li>
+     *     <li>cancelled - when the merchant cancels a payout batch (only possible for requests in the status new</li>
+     * </ul>
+     *
+     * @return the status
+     */
     @JsonIgnore
     public String getStatus() {
         return _status;
     }
 
+    /**
+     * Sets status, the possible values are:
+     * <ul>
+     *     <li>new - initial status when the payout batch is created</li>
+     *     <li>funded - if there are enough funds available on the merchant account,
+     *      the payout batches are set to funded. This happens at the daily cutoff time for payout processing,
+     *      e.g. 2pm and 9pm UTC
+     *     </li>
+     *     <li>processing - the payout batches switch to this status whenever the corresponding cryptocurrency
+     *      transactions are broadcasted by BitPay
+     *     </li>
+     *     <li>complete - the payout batches are marked as complete when the cryptocurrency transaction has reached
+     *      the typical target confirmation for the corresponding asset. For instance,
+     *      6 confirmations for a bitcoin transaction.
+     *     </li>
+     *     <li>cancelled - when the merchant cancels a payout batch (only possible for requests in the status new</li>
+     * </ul>
+     *
+     * @param status the status
+     */
     @JsonProperty("status")
     public void setStatus(String status) {
         this._status = status;
     }
 
+    /**
+     * Gets address.
+     *
+     * @return the address
+     */
     @JsonProperty("address")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public String getAddress() {
         return _address;
     }
 
+    /**
+     * Sets address.
+     *
+     * @param address the address
+     */
     @JsonProperty("address")
     public void setAddress(String address) {
         this._address = address;

src/main/java/com/bitpay/sdk/model/Payout/PayoutBatch.java

@@ -2,21 +2,40 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 
+/**
+ * The type Payout instruction btc summary.
+ */
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class PayoutInstructionBtcSummary {
 
     private final Double _paid;
     private final Double _unpaid;
 
+    /**
+     * Instantiates a new Payout instruction btc summary.
+     *
+     * @param paid   the paid
+     * @param unpaid the unpaid
+     */
     public PayoutInstructionBtcSummary(Double paid, Double unpaid) {
         this._paid = paid;
         this._unpaid = unpaid;
     }
 
+    /**
+     * Gets paid.
+     *
+     * @return the paid
+     */
     public Double getPaid() {
         return _paid;
     }
 
+    /**
+     * Gets unpaid.
+     *
+     * @return the unpaid
+     */
     public Double getUnpaid() {
         return _unpaid;
     }