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

Enabled EC Parameters support

Browse Source 
- Updated Api to enabled EC Parameters
- Updated Tests
- Updated Logging Manager
- Added a feature to do validation on accessors.
This commit is contained in:
japatel
2014-10-09 11:30:12 -05:00
parent 459293838e
commit 61a52e4623
99 changed files with 9148 additions and 3609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -7,31 +7,43 @@ use PayPal\Rest\ApiContext;
use PayPal\Rest\IResource;
use PayPal\Api\Refund;
use PayPal\Transport\PPRestCall;
use PayPal\Validation\ArgumentValidator;
/**
* Class Sale
*
* @property string id
* @property string create_time
* @property string update_time
* A sale transaction.
*
* @package PayPal\Api
*
* @property string id
* @property string create_time
* @property string update_time
* @property \PayPal\Api\Amount amount
* @property string state
* @property string parent_payment
* @property \PayPal\Api\Links links
* @property string payment_mode
* @property string pending_reason
* @property string state
* @property string reason_code
* @property string protection_eligibility
* @property string protection_eligibility_type
* @property string clearing_time
* @property string parent_payment
* @property \PayPal\Api\Links links
*/
class Sale extends PPModel implements IResource
{
/**
* @var
* OAuth Credentials to use for this call
*
* @var \PayPal\Auth\OAuthTokenCredential $credential
*/
private static $credential;
protected static $credential;
/**
* Set Credential
*
* @param $credential
* Sets Credential
*
* @deprecated Pass ApiContext to create/get methods instead
* @param \PayPal\Auth\OAuthTokenCredential $credential
*/
public static function setCredential($credential)
{
@@ -39,23 +51,21 @@ class Sale extends PPModel implements IResource
}
/**
* Set ID
* Identifier of the authorization transaction
* Identifier of the authorization transaction.
*
*
* @param string $id
*
*
* @return $this
*/
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* Get ID
* Identifier of the authorization transaction
* Identifier of the authorization transaction.
*
* @return string
*/
@@ -65,23 +75,21 @@ class Sale extends PPModel implements IResource
}
/**
* Set Create Time
* Time the resource was created
* Time the resource was created.
*
*
* @param string $create_time
*
*
* @return $this
*/
public function setCreateTime($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Get Create Time
* Time the resource was created
* Time the resource was created.
*
* @return string
*/
@@ -91,27 +99,22 @@ class Sale extends PPModel implements IResource
}
/**
* Set Create Time
* Time the resource was created
* Time the resource was created.
*
* @deprecated Instead use setCreateTime
*
* @param string $create_time
*
* @deprecated Use setCreateTime
*
* @return $this
*/
public function setCreate_time($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Get Create Time
* Time the resource was created
*
* @deprecated Use getCreateTime
* Time the resource was created.
* @deprecated Instead use getCreateTime
*
* @return string
*/
@@ -121,23 +124,21 @@ class Sale extends PPModel implements IResource
}
/**
* Set Update Time
* Time the resource was last updated
* Time the resource was last updated.
*
*
* @param string $update_time
*
*
* @return $this
*/
public function setUpdateTime($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Get Update Time
* Time the resource was last updated
* Time the resource was last updated.
*
* @return string
*/
@@ -147,27 +148,22 @@ class Sale extends PPModel implements IResource
}
/**
* Set Update Time
* Time the resource was last updated
* Time the resource was last updated.
*
* @deprecated Instead use setUpdateTime
*
* @param string $update_time
*
* @deprecated Use setUpdateTime
*
* @return $this
*/
public function setUpdate_time($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Get Update Time
* Time the resource was last updated
*
* @deprecated Use getUpdateTime
* Time the resource was last updated.
* @deprecated Instead use getUpdateTime
*
* @return string
*/
@@ -177,23 +173,21 @@ class Sale extends PPModel implements IResource
}
/**
* Set Amount
* Amount being collected
* Amount being collected.
*
*
* @param \PayPal\Api\Amount $amount
*
*
* @return $this
*/
public function setAmount($amount)
{
$this->amount = $amount;
return $this;
}
/**
* Get Amount
* Amount being collected
* Amount being collected.
*
* @return \PayPal\Api\Amount
*/
@@ -203,23 +197,119 @@ class Sale extends PPModel implements IResource
}
/**
* Set State
* State of the sale transaction
* specifies payment mode of the transaction
* Valid Values: ["INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"]
*
* @param string $payment_mode
*
* @return $this
*/
public function setPaymentMode($payment_mode)
{
$this->payment_mode = $payment_mode;
return $this;
}
/**
* specifies payment mode of the transaction
*
* @return string
*/
public function getPaymentMode()
{
return $this->payment_mode;
}
/**
* specifies payment mode of the transaction
*
* @deprecated Instead use setPaymentMode
*
* @param string $payment_mode
* @return $this
*/
public function setPayment_mode($payment_mode)
{
$this->payment_mode = $payment_mode;
return $this;
}
/**
* specifies payment mode of the transaction
* @deprecated Instead use getPaymentMode
*
* @return string
*/
public function getPayment_mode()
{
return $this->payment_mode;
}
/**
* Reason of Pending transaction.
*
*
* @param string $pending_reason
*
* @return $this
*/
public function setPendingReason($pending_reason)
{
$this->pending_reason = $pending_reason;
return $this;
}
/**
* Reason of Pending transaction.
*
* @return string
*/
public function getPendingReason()
{
return $this->pending_reason;
}
/**
* Reason of Pending transaction.
*
* @deprecated Instead use setPendingReason
*
* @param string $pending_reason
* @return $this
*/
public function setPending_reason($pending_reason)
{
$this->pending_reason = $pending_reason;
return $this;
}
/**
* Reason of Pending transaction.
* @deprecated Instead use getPendingReason
*
* @return string
*/
public function getPending_reason()
{
return $this->pending_reason;
}
/**
* State of the sale transaction.
* Valid Values: ["pending", "completed", "refunded", "partially_refunded"]
*
* @param string $state
*
*
* @return $this
*/
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* Get State
* State of the sale transaction
* State of the sale transaction.
*
* @return string
*/
@@ -229,23 +319,217 @@ class Sale extends PPModel implements IResource
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
* 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"]
*
* @param string $reason_code
*
* @return $this
*/
public function setReasonCode($reason_code)
{
$this->reason_code = $reason_code;
return $this;
}
/**
* Reason code for the transaction state being Pending or Reversed.
*
* @return string
*/
public function getReasonCode()
{
return $this->reason_code;
}
/**
* Reason code for the transaction state being Pending or Reversed.
*
* @deprecated Instead use setReasonCode
*
* @param string $reason_code
* @return $this
*/
public function setReason_code($reason_code)
{
$this->reason_code = $reason_code;
return $this;
}
/**
* Reason code for the transaction state being Pending or Reversed.
* @deprecated Instead use getReasonCode
*
* @return string
*/
public function getReason_code()
{
return $this->reason_code;
}
/**
* Protection Eligibility of the Payer
* Valid Values: ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"]
*
* @param string $protection_eligibility
*
* @return $this
*/
public function setProtectionEligibility($protection_eligibility)
{
$this->protection_eligibility = $protection_eligibility;
return $this;
}
/**
* Protection Eligibility of the Payer
*
* @return string
*/
public function getProtectionEligibility()
{
return $this->protection_eligibility;
}
/**
* Protection Eligibility of the Payer
*
* @deprecated Instead use setProtectionEligibility
*
* @param string $protection_eligibility
* @return $this
*/
public function setProtection_eligibility($protection_eligibility)
{
$this->protection_eligibility = $protection_eligibility;
return $this;
}
/**
* Protection Eligibility of the Payer
* @deprecated Instead use getProtectionEligibility
*
* @return string
*/
public function getProtection_eligibility()
{
return $this->protection_eligibility;
}
/**
* Protection Eligibility Type of the Payer
* Valid Values: ["ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE", "INELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE"]
*
* @param string $protection_eligibility_type
*
* @return $this
*/
public function setProtectionEligibilityType($protection_eligibility_type)
{
$this->protection_eligibility_type = $protection_eligibility_type;
return $this;
}
/**
* Protection Eligibility Type of the Payer
*
* @return string
*/
public function getProtectionEligibilityType()
{
return $this->protection_eligibility_type;
}
/**
* Protection Eligibility Type of the Payer
*
* @deprecated Instead use setProtectionEligibilityType
*
* @param string $protection_eligibility_type
* @return $this
*/
public function setProtection_eligibility_type($protection_eligibility_type)
{
$this->protection_eligibility_type = $protection_eligibility_type;
return $this;
}
/**
* Protection Eligibility Type of the Payer
* @deprecated Instead use getProtectionEligibilityType
*
* @return string
*/
public function getProtection_eligibility_type()
{
return $this->protection_eligibility_type;
}
/**
* Expected clearing time for eCheck Transactions
*
*
* @param string $clearing_time
*
* @return $this
*/
public function setClearingTime($clearing_time)
{
$this->clearing_time = $clearing_time;
return $this;
}
/**
* Expected clearing time for eCheck Transactions
*
* @return string
*/
public function getClearingTime()
{
return $this->clearing_time;
}
/**
* Expected clearing time for eCheck Transactions
*
* @deprecated Instead use setClearingTime
*
* @param string $clearing_time
* @return $this
*/
public function setClearing_time($clearing_time)
{
$this->clearing_time = $clearing_time;
return $this;
}
/**
* Expected clearing time for eCheck Transactions
* @deprecated Instead use getClearingTime
*
* @return string
*/
public function getClearing_time()
{
return $this->clearing_time;
}
/**
* ID of the Payment resource that this transaction is based on.
*
*
* @param string $parent_payment
*
*
* @return $this
*/
public function setParentPayment($parent_payment)
{
$this->parent_payment = $parent_payment;
return $this;
}
/**
* Get Parent Payment
* ID of the Payment resource that this transaction is based on
* ID of the Payment resource that this transaction is based on.
*
* @return string
*/
@@ -255,27 +539,22 @@ class Sale extends PPModel implements IResource
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
* ID of the Payment resource that this transaction is based on.
*
* @deprecated Instead use setParentPayment
*
* @param string $parent_payment
*
* @deprecated Use setParentPayment
*
* @return $this
*/
public function setParent_payment($parent_payment)
{
$this->parent_payment = $parent_payment;
return $this;
}
/**
* Get Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @deprecated Use getParentPayment
* ID of the Payment resource that this transaction is based on.
* @deprecated Instead use getParentPayment
*
* @return string
*/
@@ -285,23 +564,23 @@ class Sale extends PPModel implements IResource
}
/**
* Set Links
* Sets Links
*
*
* @param \PayPal\Api\Links $links
*
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
* Gets Links
*
* @return \PayPal\Api\Links
* @return \PayPal\Api\Links[]
*/
public function getLinks()
{
@@ -309,66 +588,48 @@ class Sale extends PPModel implements IResource
}
/**
* Get
*
* @param int $saleId
* @param \PayPal\Rest\ApiContext|null $apiContext
* Obtain the Sale transaction resource for the given identifier.
*
* @param string $saleId
* @param \PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @return Sale
* @throws \InvalidArgumentException
*/
public static function get($saleId, $apiContext = null)
{
if (($saleId == null) || (strlen($saleId) <= 0)) {
throw new \InvalidArgumentException("saleId cannot be null or empty");
}
ArgumentValidator::validate($saleId, 'saleId');
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/sale/$saleId", "GET", $payLoad);
$ret = new Sale();
$ret->fromJson($json);
return $ret;
}
/**
* Refund
*
* @param \Paypal\Api\Refund $refund
* @param \PayPal\Rest\ApiContext|null $apiContext
* Creates (and processes) a new Refund Transaction added as a related resource.
*
* @param Refund $refund
* @param \PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @return Refund
* @throws \InvalidArgumentException
*/
public function refund($refund, $apiContext = null)
{
if ($this->getId() == null) {
throw new \InvalidArgumentException("Id cannot be null");
}
if (($refund == null)) {
throw new \InvalidArgumentException("refund cannot be null or empty");
}
ArgumentValidator::validate($this->getId(), "Id");
ArgumentValidator::validate($refund, 'refund');
$payLoad = $refund->toJSON();
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/sale/{$this->getId()}/refund", "POST", $payLoad);
$ret = new Refund();
$ret->fromJson($json);
return $ret;
}
}