lxbfYeaa/PayPal-PHP-SDK
Archived
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-SDK
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'chaitanyakuber-transaction-fee-patch'

Browse Source
This commit is contained in:
japatel
2015-02-03 14:28:45 -06:00
parent 0e9894b4c4 ec46c397fe
commit 82a0e08e00
3 changed files with 87 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
lib/PayPal/Api/Sale.php
View File

@@ -3,8 +3,6 @@
namespace PayPal\Api; namespace PayPal\Api;
use PayPal\Common\PayPalResourceModel; use PayPal\Common\PayPalResourceModel;
use PayPal\Rest\ApiContext;
use PayPal\Api\Refund;
use PayPal\Transport\PayPalRestCall; use PayPal\Transport\PayPalRestCall;
use PayPal\Validation\ArgumentValidator; use PayPal\Validation\ArgumentValidator;
@@ -13,7 +11,6 @@ use PayPal\Validation\ArgumentValidator;
* *
* A sale transaction. * A sale transaction.
* *
* @package PayPal\Api
* *
* @property string id * @property string id
* @property string create_time * @property string create_time
@@ -27,15 +24,17 @@ use PayPal\Validation\ArgumentValidator;
* @property string protection_eligibility_type * @property string protection_eligibility_type
* @property string clearing_time * @property string clearing_time
* @property string parent_payment * @property string parent_payment
* @property \PayPal\Api\Currency $transaction_fee
* @package PayPal\Api
*/ */
class Sale extends PayPalResourceModel class Sale extends PayPalResourceModel
{ {
/** /**
* Identifier of the authorization transaction. * Identifier of the authorization transaction.
*
* *
* @param string $id *
* *
* @param string $id
* @return $this * @return $this
*/ */
public function setId($id) public function setId($id)
@@ -56,10 +55,10 @@ class Sale extends PayPalResourceModel
/** /**
* Time the resource was created. * Time the resource was created.
*
* *
* @param string $create_time *
* *
* @param string $create_time
* @return $this * @return $this
*/ */
public function setCreateTime($create_time) public function setCreateTime($create_time)
@@ -80,10 +79,10 @@ class Sale extends PayPalResourceModel
/** /**
* Time the resource was last updated. * Time the resource was last updated.
*
* *
* @param string $update_time *
* *
* @param string $update_time
* @return $this * @return $this
*/ */
public function setUpdateTime($update_time) public function setUpdateTime($update_time)
@@ -104,10 +103,10 @@ class Sale extends PayPalResourceModel
/** /**
* Amount being collected. * Amount being collected.
*
* *
* @param \PayPal\Api\Amount $amount *
* *
* @param \PayPal\Api\Amount $amount
* @return $this * @return $this
*/ */
public function setAmount($amount) public function setAmount($amount)
@@ -128,10 +127,10 @@ class Sale extends PayPalResourceModel
/** /**
* specifies payment mode of the transaction * specifies payment mode of the transaction
* Valid Values: ["INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"] * Valid Values: ["INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"]
* *
* @param string $payment_mode *
* * @param string $payment_mode
* @return $this * @return $this
*/ */
public function setPaymentMode($payment_mode) public function setPaymentMode($payment_mode)
@@ -152,10 +151,10 @@ class Sale extends PayPalResourceModel
/** /**
* Reason of Pending transaction. * Reason of Pending transaction.
*
* *
* @param string $pending_reason *
* *
* @param string $pending_reason
* @return $this * @return $this
*/ */
public function setPendingReason($pending_reason) public function setPendingReason($pending_reason)
@@ -176,10 +175,10 @@ class Sale extends PayPalResourceModel
/** /**
* State of the sale transaction. * State of the sale transaction.
* Valid Values: ["pending", "completed", "refunded", "partially_refunded"] * Valid Values: ["pending", "completed", "refunded", "partially_refunded"]
* *
* @param string $state *
* * @param string $state
* @return $this * @return $this
*/ */
public function setState($state) public function setState($state)
@@ -200,10 +199,10 @@ class Sale extends PayPalResourceModel
/** /**
* Reason code for the transaction state being Pending or Reversed. * Reason code for the transaction state being Pending or Reversed.
* Valid Values: ["CHARGEBACK", "GUARANTEE", "BUYER_COMPLAINT", "REFUND", "UNCONFIRMED_SHIPPING_ADDRESS", "ECHECK", "INTERNATIONAL_WITHDRAWAL", "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION", "PAYMENT_REVIEW", "REGULATORY_REVIEW", "UNILATERAL", "VERIFICATION_REQUIRED"] * Valid Values: ["CHARGEBACK", "GUARANTEE", "BUYER_COMPLAINT", "REFUND", "UNCONFIRMED_SHIPPING_ADDRESS", "ECHECK", "INTERNATIONAL_WITHDRAWAL", "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION", "PAYMENT_REVIEW", "REGULATORY_REVIEW", "UNILATERAL", "VERIFICATION_REQUIRED"]
* *
* @param string $reason_code *
* * @param string $reason_code
* @return $this * @return $this
*/ */
public function setReasonCode($reason_code) public function setReasonCode($reason_code)
@@ -223,11 +222,11 @@ class Sale extends PayPalResourceModel
} }
/** /**
* Protection Eligibility of the Payer * Protection Eligibility of the Payer
* Valid Values: ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"] * Valid Values: ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"]
* *
* @param string $protection_eligibility *
* * @param string $protection_eligibility
* @return $this * @return $this
*/ */
public function setProtectionEligibility($protection_eligibility) public function setProtectionEligibility($protection_eligibility)
@@ -237,7 +236,7 @@ class Sale extends PayPalResourceModel
} }
/** /**
* Protection Eligibility of the Payer * Protection Eligibility of the Payer
* *
* @return string * @return string
*/ */
@@ -247,11 +246,11 @@ class Sale extends PayPalResourceModel
} }
/** /**
* Protection Eligibility Type of the Payer * Protection Eligibility Type of the Payer
* Valid Values: ["ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE", "INELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE"] * Valid Values: ["ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE", "INELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE"]
* *
* @param string $protection_eligibility_type *
* * @param string $protection_eligibility_type
* @return $this * @return $this
*/ */
public function setProtectionEligibilityType($protection_eligibility_type) public function setProtectionEligibilityType($protection_eligibility_type)
@@ -261,7 +260,7 @@ class Sale extends PayPalResourceModel
} }
/** /**
* Protection Eligibility Type of the Payer * Protection Eligibility Type of the Payer
* *
* @return string * @return string
*/ */
@@ -271,11 +270,34 @@ class Sale extends PayPalResourceModel
} }
/** /**
* Expected clearing time for eCheck Transactions * Transaction fee applicable for this payment.
*
* *
* @param string $clearing_time * @param Currency $transaction_fee
* * @return $this
*/
public function setTransactionFee($transaction_fee)
{
$this->transaction_fee = $transaction_fee;
return $this;
}
/**
* Transaction fee applicable for this payment.
*
* @return \PayPal\Api\Currency
*/
public function getTransactionFee()
{
return $this->transaction_fee;
}
/**
* Expected clearing time for eCheck Transactions
*
*
*
* @param string $clearing_time
* @return $this * @return $this
*/ */
public function setClearingTime($clearing_time) public function setClearingTime($clearing_time)
@@ -296,10 +318,10 @@ class Sale extends PayPalResourceModel
/** /**
* ID of the Payment resource that this transaction is based on. * ID of the Payment resource that this transaction is based on.
*
* *
* @param string $parent_payment *
* *
* @param string $parent_payment
* @return $this * @return $this
*/ */
public function setParentPayment($parent_payment) public function setParentPayment($parent_payment)
@@ -321,9 +343,9 @@ class Sale extends PayPalResourceModel
/** /**
* Obtain the Sale transaction resource for the given identifier. * Obtain the Sale transaction resource for the given identifier.
* *
* @param string $saleId * @param string $saleId
* @param \PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param \PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return Sale * @return Sale
*/ */
public static function get($saleId, $apiContext = null, $restCall = null) public static function get($saleId, $apiContext = null, $restCall = null)
@@ -347,9 +369,9 @@ class Sale extends PayPalResourceModel
/** /**
* Creates (and processes) a new Refund Transaction added as a related resource. * Creates (and processes) a new Refund Transaction added as a related resource.
* *
* @param Refund $refund * @param Refund $refund
* @param \PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param \PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return Refund * @return Refund
*/ */
public function refund($refund, $apiContext = null, $restCall = null) public function refund($refund, $apiContext = null, $restCall = null)

23
tests/PayPal/Test/Api/SaleTest.php
View File

@@ -1,19 +1,17 @@
<?php <?php
namespace PayPal\Test\Api; namespace PayPal\Test\Api;
use PayPal\Api\Refund; use PayPal\Api\Currency;
use PayPal\Api\Sale; use PayPal\Api\Sale;
use PayPal\Test\Constants;
use PayPal\Test\Api\AmountTest; use PayPal\Test\Api\AmountTest;
use PayPal\Test\Api\PaymentTest;
use PayPal\Test\Api\LinksTest;
use PayPal\Exception\PayPalConnectionException;
class SaleTest extends \PHPUnit_Framework_TestCase class SaleTest extends \PHPUnit_Framework_TestCase
{ {
/**
/** @var Sale */ * @var Sale
*/
private $sale; private $sale;
private $tFee;
public static $captureId = "CAP-123"; public static $captureId = "CAP-123";
public static $createTime = "2013-02-28T00:00:00Z"; public static $createTime = "2013-02-28T00:00:00Z";
@@ -21,7 +19,7 @@ class SaleTest extends \PHPUnit_Framework_TestCase
public static $parentPayment = "PAY-123"; public static $parentPayment = "PAY-123";
public static $state = "Created"; public static $state = "Created";
public static function createSale() private function createSale()
{ {
$sale = new Sale(); $sale = new Sale();
$sale->setAmount(AmountTest::createAmount()); $sale->setAmount(AmountTest::createAmount());
@@ -29,12 +27,18 @@ class SaleTest extends \PHPUnit_Framework_TestCase
$sale->setId(self::$id); $sale->setId(self::$id);
$sale->setParentPayment(self::$parentPayment); $sale->setParentPayment(self::$parentPayment);
$sale->setState(self::$state); $sale->setState(self::$state);
$this->tFee = new Currency();
$this->tFee->setCurrency('AUD');
$this->tFee->setValue('0.10');
$sale->setTransactionFee($this->tFee);
return $sale; return $sale;
} }
public function setup() public function setup()
{ {
$this->sale = self::createSale(); $this->sale = $this->createSale();
} }
public function testGetterSetter() public function testGetterSetter()
@@ -44,6 +48,7 @@ class SaleTest extends \PHPUnit_Framework_TestCase
$this->assertEquals(self::$parentPayment, $this->sale->getParentPayment()); $this->assertEquals(self::$parentPayment, $this->sale->getParentPayment());
$this->assertEquals(self::$state, $this->sale->getState()); $this->assertEquals(self::$state, $this->sale->getState());
$this->assertEquals(AmountTest::$currency, $this->sale->getAmount()->getCurrency()); $this->assertEquals(AmountTest::$currency, $this->sale->getAmount()->getCurrency());
$this->assertEquals($this->tFee, $this->sale->getTransactionFee());
} }
public function testSerializeDeserialize() public function testSerializeDeserialize()

4
tests/PayPal/Test/Api/TransactionTest.php
View File

@@ -2,14 +2,12 @@
namespace PayPal\Test\Api; namespace PayPal\Test\Api;
use PayPal\Api\SubTransaction;
use PayPal\Api\Transaction; use PayPal\Api\Transaction;
use PayPal\Test\Constants;
class TransactionTest extends \PHPUnit_Framework_TestCase class TransactionTest extends \PHPUnit_Framework_TestCase
{ {
/** @var Transaction */
private $transaction; private $transaction;
public static $description = "desc . . . "; public static $description = "desc . . . ";