Enabled Payout API Support

- Includes Unit and Functional Tests
- Includes Samples

lib/PayPal/Api/PayoutBatchHeader.php

@@ -0,0 +1,388 @@
+<?php
+
+namespace PayPal\Api;
+
+use PayPal\Common\PayPalModel;
+
+/**
+ * Class PayoutBatchHeader
+ *
+ * This object enables you to get payout header information for an entire batch request. This object represents payout header data, and can be the response to a batch header request.
+ *
+ * @package PayPal\Api
+ *
+ * @property string payout_batch_id
+ * @property string batch_status
+ * @property string time_created
+ * @property string time_completed
+ * @property \PayPal\Api\PayoutSenderBatchHeader sender_batch_header
+ * @property \PayPal\Api\Currency amount
+ * @property \PayPal\Api\Currency fees
+ * @property \PayPal\Api\Error errors
+ * @property \PayPal\Api\Links[] links
+ */
+class PayoutBatchHeader extends PayPalModel
+{
+    /**
+     * An ID for the batch payout. Generated by PayPal. 30 characters max.
+     *
+     * @param string $payout_batch_id
+     * 
+     * @return $this
+     */
+    public function setPayoutBatchId($payout_batch_id)
+    {
+        $this->payout_batch_id = $payout_batch_id;
+        return $this;
+    }
+
+    /**
+     * An ID for the batch payout. Generated by PayPal. 30 characters max.
+     *
+     * @return string
+     */
+    public function getPayoutBatchId()
+    {
+        return $this->payout_batch_id;
+    }
+
+    /**
+     * An ID for the batch payout. Generated by PayPal. 30 characters max.
+     *
+     * @deprecated Instead use setPayoutBatchId
+     *
+     * @param string $payout_batch_id
+     * @return $this
+     */
+    public function setPayout_batch_id($payout_batch_id)
+    {
+        $this->payout_batch_id = $payout_batch_id;
+        return $this;
+    }
+
+    /**
+     * An ID for the batch payout. Generated by PayPal. 30 characters max.
+     * @deprecated Instead use getPayoutBatchId
+     *
+     * @return string
+     */
+    public function getPayout_batch_id()
+    {
+        return $this->payout_batch_id;
+    }
+
+    /**
+     * Generated batch status.
+     *
+     * @param string $batch_status
+     * 
+     * @return $this
+     */
+    public function setBatchStatus($batch_status)
+    {
+        $this->batch_status = $batch_status;
+        return $this;
+    }
+
+    /**
+     * Generated batch status.
+     *
+     * @return string
+     */
+    public function getBatchStatus()
+    {
+        return $this->batch_status;
+    }
+
+    /**
+     * Generated batch status.
+     *
+     * @deprecated Instead use setBatchStatus
+     *
+     * @param string $batch_status
+     * @return $this
+     */
+    public function setBatch_status($batch_status)
+    {
+        $this->batch_status = $batch_status;
+        return $this;
+    }
+
+    /**
+     * Generated batch status.
+     * @deprecated Instead use getBatchStatus
+     *
+     * @return string
+     */
+    public function getBatch_status()
+    {
+        return $this->batch_status;
+    }
+
+    /**
+     * The time the batch entered processing.
+     *
+     * @param string $time_created
+     * 
+     * @return $this
+     */
+    public function setTimeCreated($time_created)
+    {
+        $this->time_created = $time_created;
+        return $this;
+    }
+
+    /**
+     * The time the batch entered processing.
+     *
+     * @return string
+     */
+    public function getTimeCreated()
+    {
+        return $this->time_created;
+    }
+
+    /**
+     * The time the batch entered processing.
+     *
+     * @deprecated Instead use setTimeCreated
+     *
+     * @param string $time_created
+     * @return $this
+     */
+    public function setTime_created($time_created)
+    {
+        $this->time_created = $time_created;
+        return $this;
+    }
+
+    /**
+     * The time the batch entered processing.
+     * @deprecated Instead use getTimeCreated
+     *
+     * @return string
+     */
+    public function getTime_created()
+    {
+        return $this->time_created;
+    }
+
+    /**
+     * The time that processing for the batch was completed.
+     *
+     * @param string $time_completed
+     * 
+     * @return $this
+     */
+    public function setTimeCompleted($time_completed)
+    {
+        $this->time_completed = $time_completed;
+        return $this;
+    }
+
+    /**
+     * The time that processing for the batch was completed.
+     *
+     * @return string
+     */
+    public function getTimeCompleted()
+    {
+        return $this->time_completed;
+    }
+
+    /**
+     * The time that processing for the batch was completed.
+     *
+     * @deprecated Instead use setTimeCompleted
+     *
+     * @param string $time_completed
+     * @return $this
+     */
+    public function setTime_completed($time_completed)
+    {
+        $this->time_completed = $time_completed;
+        return $this;
+    }
+
+    /**
+     * The time that processing for the batch was completed.
+     * @deprecated Instead use getTimeCompleted
+     *
+     * @return string
+     */
+    public function getTime_completed()
+    {
+        return $this->time_completed;
+    }
+
+    /**
+     * The original batch header as provided by the payment sender.
+     *
+     * @param \PayPal\Api\PayoutSenderBatchHeader $sender_batch_header
+     * 
+     * @return $this
+     */
+    public function setSenderBatchHeader($sender_batch_header)
+    {
+        $this->sender_batch_header = $sender_batch_header;
+        return $this;
+    }
+
+    /**
+     * The original batch header as provided by the payment sender.
+     *
+     * @return \PayPal\Api\PayoutSenderBatchHeader
+     */
+    public function getSenderBatchHeader()
+    {
+        return $this->sender_batch_header;
+    }
+
+    /**
+     * The original batch header as provided by the payment sender.
+     *
+     * @deprecated Instead use setSenderBatchHeader
+     *
+     * @param \PayPal\Api\PayoutSenderBatchHeader $sender_batch_header
+     * @return $this
+     */
+    public function setSender_batch_header($sender_batch_header)
+    {
+        $this->sender_batch_header = $sender_batch_header;
+        return $this;
+    }
+
+    /**
+     * The original batch header as provided by the payment sender.
+     * @deprecated Instead use getSenderBatchHeader
+     *
+     * @return \PayPal\Api\PayoutSenderBatchHeader
+     */
+    public function getSender_batch_header()
+    {
+        return $this->sender_batch_header;
+    }
+
+    /**
+     * Total amount, in U.S. dollars, requested for the applicable payouts.
+     *
+     * @param \PayPal\Api\Currency $amount
+     * 
+     * @return $this
+     */
+    public function setAmount($amount)
+    {
+        $this->amount = $amount;
+        return $this;
+    }
+
+    /**
+     * Total amount, in U.S. dollars, requested for the applicable payouts.
+     *
+     * @return \PayPal\Api\Currency
+     */
+    public function getAmount()
+    {
+        return $this->amount;
+    }
+
+    /**
+     * Total estimate in U.S. dollars for the applicable payouts fees.
+     *
+     * @param \PayPal\Api\Currency $fees
+     * 
+     * @return $this
+     */
+    public function setFees($fees)
+    {
+        $this->fees = $fees;
+        return $this;
+    }
+
+    /**
+     * Total estimate in U.S. dollars for the applicable payouts fees.
+     *
+     * @return \PayPal\Api\Currency
+     */
+    public function getFees()
+    {
+        return $this->fees;
+    }
+
+    /**
+     * Sets Errors
+     *
+     * @param \PayPal\Api\Error $errors
+     * 
+     * @return $this
+     */
+    public function setErrors($errors)
+    {
+        $this->errors = $errors;
+        return $this;
+    }
+
+    /**
+     * Gets Errors
+     *
+     * @return \PayPal\Api\Error
+     */
+    public function getErrors()
+    {
+        return $this->errors;
+    }
+
+    /**
+     * Sets Links
+     *
+     * @param \PayPal\Api\Links[] $links
+     * 
+     * @return $this
+     */
+    public function setLinks($links)
+    {
+        $this->links = $links;
+        return $this;
+    }
+
+    /**
+     * Gets Links
+     *
+     * @return \PayPal\Api\Links[]
+     */
+    public function getLinks()
+    {
+        return $this->links;
+    }
+
+    /**
+     * Append Links to the list.
+     *
+     * @param \PayPal\Api\Links $links
+     * @return $this
+     */
+    public function addLink($links)
+    {
+        if (!$this->getLinks()) {
+            return $this->setLinks(array($links));
+        } else {
+            return $this->setLinks(
+                array_merge($this->getLinks(), array($links))
+            );
+        }
+    }
+
+    /**
+     * Remove Links from the list.
+     *
+     * @param \PayPal\Api\Links $links
+     * @return $this
+     */
+    public function removeLink($links)
+    {
+        return $this->setLinks(
+            array_diff($this->getLinks(), array($links))
+        );
+    }
+
+}