Payments API Updates

This commit is contained in:
Jay Patel
2015-10-02 14:25:46 -05:00
parent 02fca1bda4
commit a37b880e96
112 changed files with 3857 additions and 1495 deletions

View File

@@ -4,7 +4,6 @@ namespace PayPal\Api;
use PayPal\Common\PayPalResourceModel;
use PayPal\Rest\ApiContext;
use PayPal\Transport\PayPalRestCall;
use PayPal\Validation\ArgumentValidator;
/**
@@ -14,25 +13,25 @@ use PayPal\Validation\ArgumentValidator;
*
* @package PayPal\Api
*
* @property string id
* @property string create_time
* @property string update_time
* @property \PayPal\Api\Amount amount
* @property string state
* @property string reason
* @property string sale_id
* @property string capture_id
* @property string parent_payment
* @property string description
* @property string id
* @property \PayPal\Api\Amount amount
* @property string state
* @property string reason
* @property string sale_id
* @property string capture_id
* @property string parent_payment
* @property string description
* @property string create_time
* @property string update_time
* @property \PayPal\Api\Links[] links
*/
class Refund extends PayPalResourceModel
{
/**
* Identifier of the refund transaction in UTC ISO8601 format.
* ID of the refund transaction. 17 characters max.
*
* @param string $id
*
*
* @return $this
*/
public function setId($id)
@@ -42,7 +41,7 @@ class Refund extends PayPalResourceModel
}
/**
* Identifier of the refund transaction in UTC ISO8601 format.
* ID of the refund transaction. 17 characters max.
*
* @return string
*/
@@ -52,10 +51,10 @@ class Refund extends PayPalResourceModel
}
/**
* Details including both refunded amount (to Payer) and refunded fee (to Payee).If amount is not specified, it's assumed to be full refund.
* Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
*
* @param \PayPal\Api\Amount $amount
*
*
* @return $this
*/
public function setAmount($amount)
@@ -65,7 +64,7 @@ class Refund extends PayPalResourceModel
}
/**
* Details including both refunded amount (to Payer) and refunded fee (to Payee).If amount is not specified, it's assumed to be full refund.
* Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
*
* @return \PayPal\Api\Amount
*/
@@ -75,11 +74,11 @@ class Refund extends PayPalResourceModel
}
/**
* State of the refund transaction.
* State of the refund.
* Valid Values: ["pending", "completed", "failed"]
*
* @param string $state
*
*
* @return $this
*/
public function setState($state)
@@ -89,7 +88,7 @@ class Refund extends PayPalResourceModel
}
/**
* State of the refund transaction.
* State of the refund.
*
* @return string
*/
@@ -102,7 +101,7 @@ class Refund extends PayPalResourceModel
* Reason description for the Sale transaction being refunded.
*
* @param string $reason
*
*
* @return $this
*/
public function setReason($reason)
@@ -122,10 +121,10 @@ class Refund extends PayPalResourceModel
}
/**
* ID of the Sale transaction being refunded.
* ID of the Sale transaction being refunded.
*
* @param string $sale_id
*
*
* @return $this
*/
public function setSaleId($sale_id)
@@ -135,7 +134,7 @@ class Refund extends PayPalResourceModel
}
/**
* ID of the Sale transaction being refunded.
* ID of the Sale transaction being refunded.
*
* @return string
*/
@@ -145,10 +144,10 @@ class Refund extends PayPalResourceModel
}
/**
* ID of the Capture transaction being refunded.
* ID of the sale transaction being refunded.
*
* @param string $capture_id
*
*
* @return $this
*/
public function setCaptureId($capture_id)
@@ -158,7 +157,7 @@ class Refund extends PayPalResourceModel
}
/**
* ID of the Capture transaction being refunded.
* ID of the sale transaction being refunded.
*
* @return string
*/
@@ -168,10 +167,10 @@ class Refund extends PayPalResourceModel
}
/**
* ID of the Payment resource that this transaction is based on.
* ID of the payment resource on which this transaction is based.
*
* @param string $parent_payment
*
*
* @return $this
*/
public function setParentPayment($parent_payment)
@@ -181,7 +180,7 @@ class Refund extends PayPalResourceModel
}
/**
* ID of the Payment resource that this transaction is based on.
* ID of the payment resource on which this transaction is based.
*
* @return string
*/
@@ -194,7 +193,7 @@ class Refund extends PayPalResourceModel
* Description of what is being refunded for.
*
* @param string $description
*
*
* @return $this
*/
public function setDescription($description)
@@ -214,10 +213,10 @@ class Refund extends PayPalResourceModel
}
/**
* Time the resource was created in UTC ISO8601 format.
* Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
*
* @param string $create_time
*
*
* @return $this
*/
public function setCreateTime($create_time)
@@ -227,7 +226,7 @@ class Refund extends PayPalResourceModel
}
/**
* Time the resource was created in UTC ISO8601 format.
* Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
*
* @return string
*/
@@ -237,10 +236,10 @@ class Refund extends PayPalResourceModel
}
/**
* Time the resource was last updated in UTC ISO8601 format.
* Time that the resource was last updated.
*
* @param string $update_time
*
*
* @return $this
*/
public function setUpdateTime($update_time)
@@ -250,7 +249,7 @@ class Refund extends PayPalResourceModel
}
/**
* Time the resource was last updated in UTC ISO8601 format.
* Time that the resource was last updated.
*
* @return string
*/
@@ -262,9 +261,9 @@ class Refund extends PayPalResourceModel
/**
* Retrieve details about a specific refund by passing the refund_id in the request URI.
*
* @param string $refundId
* @param 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 string $refundId
* @param 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
* @return Refund
*/
public static function get($refundId, $apiContext = null, $restCall = null)