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

Cleaned up Code Comments and added Type-Hinting to all Class/Functions

Browse Source
This commit is contained in:
Sammie S. Taunton
2013-12-03 14:29:00 -06:00
parent caa71466fe
commit e63d28723e
30 changed files with 5686 additions and 3407 deletions
Download Patch File Download Diff File Expand all files Collapse all files

194
lib/PayPal/Api/Address.php
View File

@@ -1,167 +1,263 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Address extends PPModel {
/**
* Line 1 of the Address (eg. number, street, etc).
* @param string $line1
/**
* Class Address
*
* @property string line1
* @property string line2
* @property string city
* @property string country_code
* @property string postal_code
* @property string state
* @property string phone
*/
public function setLine1($line1) {
class Address extends PPModel
{
/**
* Set Line 1
* Address (eg. number, street, etc)
*
* @param string $line1
*
* @return $this
*/
public function setLine1($line1)
{
$this->line1 = $line1;
return $this;
}
/**
* Line 1 of the Address (eg. number, street, etc).
* Get Line 1
* Address (eg. number, street, etc)
*
* @return string
*/
public function getLine1() {
public function getLine1()
{
return $this->line1;
}
/**
* Optional line 2 of the Address (eg. suite, apt #, etc.).
* Set Line 2 (Optional)
* Address (eg. suite, apt #, etc)
*
* @param string $line2
*
* @return $this
*/
public function setLine2($line2) {
public function setLine2($line2)
{
$this->line2 = $line2;
return $this;
}
/**
* Optional line 2 of the Address (eg. suite, apt #, etc.).
* Get Line 2 (Optional)
* Address (eg. suite, apt #, etc)
*
* @return string
*/
public function getLine2() {
public function getLine2()
{
return $this->line2;
}
/**
* City name.
* Set City Name
*
* @param string $city
*
* @return $this
*/
public function setCity($city) {
public function setCity($city)
{
$this->city = $city;
return $this;
}
/**
* City name.
* Get City Name
*
* @return string
*/
public function getCity() {
public function getCity()
{
return $this->city;
}
/**
* 2 letter country code.
* Set Country Code
* Two Letter
*
* @param string $country_code
*
* @return $this
*/
public function setCountryCode($country_code) {
public function setCountryCode($country_code)
{
$this->country_code = $country_code;
return $this;
}
/**
* 2 letter country code.
* Get Country Code
* Two Letter
*
* @return string
*/
public function getCountryCode() {
public function getCountryCode()
{
return $this->country_code;
}
/**
* 2 letter country code.
* Set Country Code
* Two Letter
*
* @param string $country_code
* @deprecated. Instead use setCountryCode
*
* @deprecated Use setCountryCode
*
* @return $this
*/
public function setCountry_code($country_code) {
public function setCountry_code($country_code)
{
$this->country_code = $country_code;
return $this;
}
/**
* 2 letter country code.
* Get Country Code
* Two Letter
*
* @deprecated Use getCountryCode
*
* @return string
* @deprecated. Instead use getCountryCode
*/
public function getCountry_code() {
public function getCountry_code()
{
return $this->country_code;
}
/**
* Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.
* Set Postal Code
* Zip code or equivalent is usually required for countries that have them
* For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code
*
* @param string $postal_code
*
* @return $this
*/
public function setPostalCode($postal_code) {
public function setPostalCode($postal_code)
{
$this->postal_code = $postal_code;
return $this;
}
/**
* Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.
* Get Postal Code
* Zip code or equivalent is usually required for countries that have them
* For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code
*
* @return string
*/
public function getPostalCode() {
public function getPostalCode()
{
return $this->postal_code;
}
/**
* Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.
* Set Postal Code
* Zip code or equivalent is usually required for countries that have them
* For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code
*
* @param string $postal_code
* @deprecated. Instead use setPostalCode
*
* @deprecated Use setPostalCode
*
* @return $this
*/
public function setPostal_code($postal_code) {
public function setPostal_code($postal_code)
{
$this->postal_code = $postal_code;
return $this;
}
/**
* Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.
* Get Postal Code
* Zip code or equivalent is usually required for countries that have them
* For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code
*
* @deprecated Use getPostalCode
*
* @return string
* @deprecated. Instead use getPostalCode
*/
public function getPostal_code() {
public function getPostal_code()
{
return $this->postal_code;
}
/**
* 2 letter code for US states, and the equivalent for other countries.
* Set State
* Two Letter Code for US States and the equivalent for other countries
*
* @param string $state
*
* @return $this
*/
public function setState($state) {
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* 2 letter code for US states, and the equivalent for other countries.
* Get State
* Two Letter Code for US States and the equivalent for other countries
*
* @return string
*/
public function getState() {
public function getState()
{
return $this->state;
}
/**
* Phone number in E.123 format.
* Set Phone Number
* E.123 format
*
* @param string $phone
*
* @return $this
*/
public function setPhone($phone) {
public function setPhone($phone)
{
$this->phone = $phone;
return $this;
}
/**
* Phone number in E.123 format.
* Get Phone Number
* E.123 format
*
* @return string
*/
public function getPhone() {
public function getPhone()
{
return $this->phone;
}
}

76
lib/PayPal/Api/Amount.php
View File

@@ -1,61 +1,95 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Amount extends PPModel {
/**
* 3 letter currency code
* @param string $currency
/**
* Class Amount
*
* @property string currency
* @property string total
* @property \PayPal\Api\Details details
*/
public function setCurrency($currency) {
class Amount extends PPModel
{
/**
* Set Currency
* Three Letter Currency Code
*
* @param string $currency
*
* @return $this
*/
public function setCurrency($currency)
{
$this->currency = $currency;
return $this;
}
/**
* 3 letter currency code
* Get Currency
* Three Letter Currency Code
*
* @return string
*/
public function getCurrency() {
public function getCurrency()
{
return $this->currency;
}
/**
* Total amount charged from the Payer account (or card) to Payee. In case of a refund, this is the refunded amount to the original Payer from Payee account.
* Set Total
* Amount charged from the Payer account (or card) to Payee
* In case of a refund, this is the refunded amount to the original Payer from Payee account
*
* @param string $total
*
* @return $this
*/
public function setTotal($total) {
public function setTotal($total)
{
$this->total = $total;
return $this;
}
/**
* Total amount charged from the Payer account (or card) to Payee. In case of a refund, this is the refunded amount to the original Payer from Payee account.
* Get Total
* Amount charged from the Payer account (or card) to Payee
* In case of a refund, this is the refunded amount to the original Payer from Payee account
*
* @return string
*/
public function getTotal() {
public function getTotal()
{
return $this->total;
}
/**
* Additional details of the payment amount.
* @param PayPal\Api\Details $details
* Set Details
* Additional Details of Payment Amount
*
* @param \PayPal\Api\Details $details
*
* @return $this
*/
public function setDetails($details) {
public function setDetails($details)
{
$this->details = $details;
return $this;
}
/**
* Additional details of the payment amount.
* @return PayPal\Api\Details
* Get Details
* Additional Details of Payment Amount
*
* @return \PayPal\Api\Details
*/
public function getDetails() {
public function getDetails()
{
return $this->details;
}
}

437
lib/PayPal/Api/Authorization.php
View File

@@ -1,299 +1,484 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\IResource;
use PayPal\Rest\Call;
use PayPal\Rest\ApiContext;
use PayPal\Api\Authorization;
use PayPal\Api\Capture;
use PayPal\Rest\IResource;
use PayPal\Transport\PPRestCall;
class Authorization extends PPModel implements IResource {
/**
* Class Authorization
*
* @property string id
* @property string create_time
* @property string update_time
* @property \PayPal\Api\Amount amount
* @property string state
* @property string parent_payment
* @property string valid_until
* @property \PayPal\Api\Links links
*/
class Authorization extends PPModel implements IResource
{
/**
* @var
*/
private static $credential;
/**
* Set Credential
*
* @deprecated. Pass ApiContext to create/get methods instead
* @param $credential
*
* @deprecated Pass ApiContext to create/get methods instead
*/
public static function setCredential($credential) {
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* Identifier of the authorization transaction.
* Set ID
* Identifier of the authorization transaction
*
* @param string $id
*
* @return $this
*/
public function setId($id) {
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* Identifier of the authorization transaction.
* Get ID
* Identifier of the authorization transaction
*
* @return string
*/
public function getId() {
public function getId()
{
return $this->id;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
*
* @return $this
*/
public function setCreateTime($create_time) {
public function setCreateTime($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @return string
*/
public function getCreateTime() {
public function getCreateTime()
{
return $this->create_time;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
* @deprecated. Instead use setCreateTime
*
* @deprecated Use setCreateTime
*
* @return $this
*/
public function setCreate_time($create_time) {
public function setCreate_time($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @deprecated Use getCreateTime
*
* @return string
* @deprecated. Instead use getCreateTime
*/
public function getCreate_time() {
public function getCreate_time()
{
return $this->create_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
*
* @return $this
*/
public function setUpdateTime($update_time) {
public function setUpdateTime($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @return string
*/
public function getUpdateTime() {
public function getUpdateTime()
{
return $this->update_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
* @deprecated. Instead use setUpdateTime
*
* @deprecated Use setUpdateTime
*
* @return $this
*/
public function setUpdate_time($update_time) {
public function setUpdate_time($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @deprecated Use getUpdateTime
*
* @return string
* @deprecated. Instead use getUpdateTime
*/
public function getUpdate_time() {
public function getUpdate_time()
{
return $this->update_time;
}
/**
* Amount being authorized for.
* @param PayPal\Api\Amount $amount
* Set Amount
*
* @param \PayPal\Api\Amount $amount
*
* @return $this
*/
public function setAmount($amount) {
public function setAmount($amount)
{
$this->amount = $amount;
return $this;
}
/**
* Amount being authorized for.
* @return PayPal\Api\Amount
* Get Amount
*
* @return \PayPal\Api\Amount
*/
public function getAmount() {
public function getAmount()
{
return $this->amount;
}
/**
* State of the authorization transaction.
* Set State
* State of the authorization transaction
*
* @param string $state
*
* @return $this
*/
public function setState($state) {
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* State of the authorization transaction.
* Get State
* State of the authorization transaction
*
* @return string
*/
public function getState() {
public function getState()
{
return $this->state;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
*/
public function setParentPayment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
*/
public function getParentPayment() {
return $this->parent_payment;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
* @deprecated. Instead use setParentPayment
*/
public function setParent_payment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
* @deprecated. Instead use getParentPayment
*/
public function getParent_payment() {
return $this->parent_payment;
}
/**
* Date/Time until which funds may be captured against this resource.
* @param string $valid_until
*/
public function setValidUntil($valid_until) {
$this->valid_until = $valid_until;
return $this;
}
/**
* Date/Time until which funds may be captured against this resource.
* @return string
*/
public function getValidUntil() {
return $this->valid_until;
}
/**
* Date/Time until which funds may be captured against this resource.
* @param string $valid_until
* @deprecated. Instead use setValidUntil
*/
public function setValid_until($valid_until) {
$this->valid_until = $valid_until;
return $this;
}
/**
* Date/Time until which funds may be captured against this resource.
* @return string
* @deprecated. Instead use getValidUntil
*/
public function getValid_until() {
return $this->valid_until;
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @array
* @param PayPal\Api\Links $links
* @param string $parent_payment
*
* @return $this
*/
public function setLinks($links) {
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
*
* @return string
*/
public function getParentPayment()
{
return $this->parent_payment;
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @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
*
* @return string
*/
public function getParent_payment()
{
return $this->parent_payment;
}
/**
* Set Valid Until
* Date/Time until which funds may be captured against this resource
*
* @param string $valid_until
*
* @return $this
*/
public function setValidUntil($valid_until)
{
$this->valid_until = $valid_until;
return $this;
}
/**
* Get Valid Until
* Date/Time until which funds may be captured against this resource
*
* @return string
*/
public function getValidUntil()
{
return $this->valid_until;
}
/**
* Set Valid Until
* Date/Time until which funds may be captured against this resource
*
* @param string $valid_until
*
* @deprecated Use setValidUntil
*
* @return $this
*/
public function setValid_until($valid_until)
{
$this->valid_until = $valid_until;
return $this;
}
/**
* Get Valid Until
* Date/Time until which funds may be captured against this resource
*
* @deprecated Use getValidUntil
*
* @return string
*/
public function getValid_until()
{
return $this->valid_until;
}
/**
* Set Links
*
* @param \PayPal\Api\Links $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
*
* @return PayPal\Api\Links
* @return \PayPal\Api\Links
*/
public function getLinks() {
public function getLinks()
{
return $this->links;
}
public static function get($authorizationId, $apiContext = null) {
/**
* Get
*
* @param int $authorizationId
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return Authorization
* @throws \InvalidArgumentException
*/
public static function get($authorizationId, $apiContext = null)
{
if (($authorizationId == null) || (strlen($authorizationId) <= 0)) {
throw new \InvalidArgumentException("authorizationId cannot be null or empty");
}
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/authorization/$authorizationId", "GET", $payLoad);
$ret = new Authorization();
$ret->fromJson($json);
return $ret;
}
public function capture($capture, $apiContext = null) {
/**
* Capture
*
* @param \Paypal\Api\Capture $capture
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return Capture
* @throws \InvalidArgumentException
*/
public function capture($capture, $apiContext = null)
{
if ($this->getId() == null) {
throw new \InvalidArgumentException("Id cannot be null");
}
if (($capture == null)) {
throw new \InvalidArgumentException("capture cannot be null or empty");
}
$payLoad = $capture->toJSON();
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/authorization/{$this->getId()}/capture", "POST", $payLoad);
$ret = new Capture();
$ret->fromJson($json);
return $ret;
}
public function void($apiContext = null) {
/**
* Void
*
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return Authorization
* @throws \InvalidArgumentException
*/
public function void($apiContext = null)
{
if ($this->getId() == null) {
throw new \InvalidArgumentException("Id cannot be null");
}
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/authorization/{$this->getId()}/void", "POST", $payLoad);
$ret = new Authorization();
$ret->fromJson($json);
return $ret;
}
public function reauthorize($apiContext = null) {
/**
* Reauthorize
*
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return $this
* @throws \InvalidArgumentException
*/
public function reauthorize($apiContext = null)
{
if ($this->getId() == null) {
throw new \InvalidArgumentException("Id cannot be null");
}
$payLoad = $this->toJSON();
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/authorization/{$this->getId()}/reauthorize", "POST", $payLoad);
$this->fromJson($json);
return $this;
}
}

366
lib/PayPal/Api/Capture.php
View File

@@ -1,270 +1,438 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\IResource;
use PayPal\Rest\Call;
use PayPal\Rest\ApiContext;
use PayPal\Api\Capture;
use PayPal\Api\Refund;
use PayPal\Rest\IResource;
use PayPal\Transport\PPRestCall;
class Capture extends PPModel implements IResource {
/**
* Class Capture
*
* @property string id
* @property string create_time
* @property string update_time
* @property \PayPal\Api\Amount amount
* @property bool is_final_capture
* @property string state
* @property string parent_payment
* @property \PayPal\Api\Links links
*/
class Capture extends PPModel implements IResource
{
/**
* @var
*/
private static $credential;
/**
* @param $credential
*
* @deprecated. Pass ApiContext to create/get methods instead
* @deprecated Pass ApiContext to create/get methods instead
*/
public static function setCredential($credential) {
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* Identifier of the Capture transaction.
* Set ID
* Identifier of the Capture transaction
*
* @param string $id
*
* @return $this
*/
public function setId($id) {
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* Identifier of the Capture transaction.
* Get ID
* Identifier of the Capture transaction
*
* @return string
*/
public function getId() {
public function getId()
{
return $this->id;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
*
* @return $this
*/
public function setCreateTime($create_time) {
public function setCreateTime($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @return string
*/
public function getCreateTime() {
public function getCreateTime()
{
return $this->create_time;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
* @deprecated. Instead use setCreateTime
*
* @deprecated Use setCreateTime
*
* @return $this
*/
public function setCreate_time($create_time) {
public function setCreate_time($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @deprecated Use getCreateTime
*
* @return string
* @deprecated. Instead use getCreateTime
*/
public function getCreate_time() {
public function getCreate_time()
{
return $this->create_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
*
* @return $this
*/
public function setUpdateTime($update_time) {
public function setUpdateTime($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @return string
*/
public function getUpdateTime() {
public function getUpdateTime()
{
return $this->update_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
* @deprecated. Instead use setUpdateTime
*
* @deprecated Use setUpdateTime
*
* @return $this
*/
public function setUpdate_time($update_time) {
public function setUpdate_time($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @deprecated Use getUpdateTime
*
* @return string
* @deprecated. Instead use getUpdateTime
*/
public function getUpdate_time() {
public function getUpdate_time()
{
return $this->update_time;
}
/**
* Amount being captured. If no amount is specified, amount is used from the authorization being captured. If amount is same as the amount that's authorized for, the state of the authorization changes to captured. If not, the state of the authorization changes to partially_captured. Alternatively, you could indicate a final capture by seting the is_final_capture flag to true.
* @param PayPal\Api\Amount $amount
* Set Amount
* Amount being captured
* If no amount is specified, amount is used from the authorization being captured
* If amount is same as the amount that's authorized for, the state of the authorization changes to captured
* If not, the state of the authorization changes to partially_captured. Alternatively, you could indicate a final capture by seting the is_final_capture flag to true
*
* @param \PayPal\Api\Amount $amount
*
* @return $this
*/
public function setAmount($amount) {
public function setAmount($amount)
{
$this->amount = $amount;
return $this;
}
/**
* Amount being captured. If no amount is specified, amount is used from the authorization being captured. If amount is same as the amount that's authorized for, the state of the authorization changes to captured. If not, the state of the authorization changes to partially_captured. Alternatively, you could indicate a final capture by seting the is_final_capture flag to true.
* @return PayPal\Api\Amount
* Get Amount
* Amount being captured
* If no amount is specified, amount is used from the authorization being captured
* If amount is same as the amount that's authorized for, the state of the authorization changes to captured
* If not, the state of the authorization changes to partially_captured. Alternatively, you could indicate a final capture by seting the is_final_capture flag to true
*
* @return \PayPal\Api\Amount
*/
public function getAmount() {
public function getAmount()
{
return $this->amount;
}
/**
* whether this is a final capture for the given authorization or not. If it's final, all the remaining funds held by the authorization, will be released in the funding instrument.
* Set Is Final Capture
* Whether this is a final capture for the given authorization or not
* If it's final, all the remaining funds held by the authorization, will be released in the funding instrument
*
* @param boolean $is_final_capture
*
* @return $this
*/
public function setIsFinalCapture($is_final_capture) {
public function setIsFinalCapture($is_final_capture)
{
$this->is_final_capture = $is_final_capture;
return $this;
}
/**
* whether this is a final capture for the given authorization or not. If it's final, all the remaining funds held by the authorization, will be released in the funding instrument.
* Get Is Final Capture
* Whether this is a final capture for the given authorization or not
* If it's final, all the remaining funds held by the authorization, will be released in the funding instrument
*
* @return boolean
*/
public function getIsFinalCapture() {
public function getIsFinalCapture()
{
return $this->is_final_capture;
}
/**
* whether this is a final capture for the given authorization or not. If it's final, all the remaining funds held by the authorization, will be released in the funding instrument.
* Set Is Final Capture
* Whether this is a final capture for the given authorization or not
* If it's final, all the remaining funds held by the authorization, will be released in the funding instrument
*
* @param boolean $is_final_capture
* @deprecated. Instead use setIsFinalCapture
*
* @deprecated Use setIsFinalCapture
*
* @return $this
*/
public function setIs_final_capture($is_final_capture) {
public function setIs_final_capture($is_final_capture)
{
$this->is_final_capture = $is_final_capture;
return $this;
}
/**
* whether this is a final capture for the given authorization or not. If it's final, all the remaining funds held by the authorization, will be released in the funding instrument.
* Get Is Final Capture
* Whether this is a final capture for the given authorization or not
* If it's final, all the remaining funds held by the authorization, will be released in the funding instrument
*
* @deprecated Use getIsFinalCapture
*
* @return boolean
* @deprecated. Instead use getIsFinalCapture
*/
public function getIs_final_capture() {
public function getIs_final_capture()
{
return $this->is_final_capture;
}
/**
* State of the capture transaction.
* Set State
* State of the capture transaction
*
* @param string $state
*
* @return $this
*/
public function setState($state) {
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* State of the capture transaction.
* Get State
* State of the capture transaction
*
* @return string
*/
public function getState() {
public function getState()
{
return $this->state;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
*/
public function setParentPayment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
*/
public function getParentPayment() {
return $this->parent_payment;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
* @deprecated. Instead use setParentPayment
*/
public function setParent_payment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
* @deprecated. Instead use getParentPayment
*/
public function getParent_payment() {
return $this->parent_payment;
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @array
* @param PayPal\Api\Links $links
* @param string $parent_payment
*
* @return $this
*/
public function setLinks($links) {
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
*
* @return string
*/
public function getParentPayment()
{
return $this->parent_payment;
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @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
*
* @return string
*/
public function getParent_payment()
{
return $this->parent_payment;
}
/**
* Set Links
*
* @param \PayPal\Api\Links $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
*
* @return PayPal\Api\Links
* @return \PayPal\Api\Links
*/
public function getLinks() {
public function getLinks()
{
return $this->links;
}
public static function get($captureId, $apiContext = null) {
/**
* Get
*
* @param int $captureId
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return Capture
* @throws \InvalidArgumentException
*/
public static function get($captureId, $apiContext = null)
{
if (($captureId == null) || (strlen($captureId) <= 0)) {
throw new \InvalidArgumentException("captureId cannot be null or empty");
}
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/capture/$captureId", "GET", $payLoad);
$ret = new Capture();
$ret->fromJson($json);
return $ret;
}
public function refund($refund, $apiContext = null) {
/**
* Refund
*
* @param \Paypal\Api\Refund $refund
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @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");
}
$payLoad = $refund->toJSON();
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/capture/{$this->getId()}/refund", "POST", $payLoad);
$ret = new Refund();
$ret->fromJson($json);
return $ret;
}
}

559
lib/PayPal/Api/CreditCard.php
View File

@@ -1,416 +1,673 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\IResource;
use PayPal\Rest\Call;
use PayPal\Rest\ApiContext;
use PayPal\Api\CreditCard;
use PayPal\Rest\IResource;
use PayPal\Transport\PPRestCall;
class CreditCard extends PPModel implements IResource {
/**
* Class CreditCard
*
* @property string id
* @property string number
* @property string type
* @property int expire_month
* @property int expire_year
* @property string cvv2
* @property string first_name
* @property string last_name
* @property \PayPal\Api\Address billing_address
* @property string payer_id
* @property string state
* @property string valid_until
* @property \PayPal\Api\Links links
*/
class CreditCard extends PPModel implements IResource
{
/**
* Private Variable
*
* @var $credential
*/
private static $credential;
/**
* Set Credential
*
* @deprecated. Pass ApiContext to create/get methods instead
* @param $credential
*
* @deprecated Pass ApiContext to create/get methods instead
*/
public static function setCredential($credential) {
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* ID of the credit card being saved for later use.
* Set ID
* ID of the credit card being saved for later use
*
* @param string $id
*
* @return $this
*/
public function setId($id) {
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* ID of the credit card being saved for later use.
* Get ID
* ID of the credit card being saved for later use
*
* @return string
*/
public function getId() {
public function getId()
{
return $this->id;
}
/**
* Card number.
* Set Number
* Credit Card
*
* @param string $number
*
* @return $this
*/
public function setNumber($number) {
public function setNumber($number)
{
$this->number = $number;
return $this;
}
/**
* Card number.
* Get Number
* Credit Card
*
* @return string
*/
public function getNumber() {
public function getNumber()
{
return $this->number;
}
/**
* Type of the Card (eg. Visa, Mastercard, etc.).
* Set Type
* (eg. Visa, Mastercard, etc)
*
* @param string $type
*
* @return $this
*/
public function setType($type) {
public function setType($type)
{
$this->type = $type;
return $this;
}
/**
* Type of the Card (eg. Visa, Mastercard, etc.).
* @return string
* Get Type
* (eg. Visa, Mastercard, etc)
*
* @return mixed
*/
public function getType() {
public function getType()
{
return $this->type;
}
/**
* card expiry month with value 1 - 12.
* @param integer $expire_month
* Set Expire Month
* (eg. 1 - 12)
*
* @param int $expire_month
*
* @return $this
*/
public function setExpireMonth($expire_month) {
public function setExpireMonth($expire_month)
{
$this->expire_month = $expire_month;
return $this;
}
/**
* card expiry month with value 1 - 12.
* @return integer
* Get Expire Month
* (eg. 1 - 12)
*
* @return int
*/
public function getExpireMonth() {
public function getExpireMonth()
{
return $this->expire_month;
}
/**
* card expiry month with value 1 - 12.
* @param integer $expire_month
* @deprecated. Instead use setExpireMonth
* Set Expire Month
* (eg. 1 - 12)
*
* @param int $expire_month
*
* @deprecated Use setExpireMonth
*
* @return $this
*/
public function setExpire_month($expire_month) {
public function setExpire_month($expire_month)
{
$this->expire_month = $expire_month;
return $this;
}
/**
* card expiry month with value 1 - 12.
* @return integer
* @deprecated. Instead use getExpireMonth
* Get Expire Month
* (eg. 1 - 12)
*
* @deprecated Use getExpireMonth
*
* @return int
*/
public function getExpire_month() {
public function getExpire_month()
{
return $this->expire_month;
}
/**
* 4 digit card expiry year
* @param integer $expire_year
* Set Expire Year
* Four Digit
*
* @param int $expire_year
*
* @return $this
*/
public function setExpireYear($expire_year) {
public function setExpireYear($expire_year)
{
$this->expire_year = $expire_year;
return $this;
}
/**
* 4 digit card expiry year
* @return integer
* Get Expire Year
* Four Digit
*
* @return int
*/
public function getExpireYear() {
public function getExpireYear()
{
return $this->expire_year;
}
/**
* 4 digit card expiry year
* @param integer $expire_year
* @deprecated. Instead use setExpireYear
* Set Expire Year
* Four Digit
*
* @param int $expire_year
*
* @deprecated Use setExpireYear
*
* @return $this
*/
public function setExpire_year($expire_year) {
public function setExpire_year($expire_year)
{
$this->expire_year = $expire_year;
return $this;
}
/**
* 4 digit card expiry year
* @return integer
* @deprecated. Instead use getExpireYear
* Get Expire Year
* Four Digit
*
* @deprecated Use getExpireYear
*
* @return int
*/
public function getExpire_year() {
public function getExpire_year()
{
return $this->expire_year;
}
/**
* Card validation code. Only supported when making a Payment but not when saving a credit card for future use.
* Set CVV2
* Card validation code
* Only supported when making a Payment but not when saving a credit card for future use
*
* @param string $cvv2
*
* @return $this
*/
public function setCvv2($cvv2) {
public function setCvv2($cvv2)
{
$this->cvv2 = $cvv2;
return $this;
}
/**
* Card validation code. Only supported when making a Payment but not when saving a credit card for future use.
* Get CVV2
* Card validation code
* Only supported when making a Payment but not when saving a credit card for future use
*
* @return string
*/
public function getCvv2() {
public function getCvv2()
{
return $this->cvv2;
}
/**
* Card holder's first name.
* Set First Name
* Card holder's first name
*
* @param string $first_name
*
* @return $this
*/
public function setFirstName($first_name) {
public function setFirstName($first_name)
{
$this->first_name = $first_name;
return $this;
}
/**
* Card holder's first name.
* Get First Name
* Card holder's first name
*
* @return string
*/
public function getFirstName() {
public function getFirstName()
{
return $this->first_name;
}
/**
* Card holder's first name.
* Set First Name
* Card holder's first name
*
* @param string $first_name
* @deprecated. Instead use setFirstName
*
* @deprecated Use setFirstName
*
* @return $this
*/
public function setFirst_name($first_name) {
public function setFirst_name($first_name)
{
$this->first_name = $first_name;
return $this;
}
/**
* Card holder's first name.
* Get First Name
* Card holder's first name
*
* @deprecated Use getFirstName
*
* @return string
* @deprecated. Instead use getFirstName
*/
public function getFirst_name() {
public function getFirst_name()
{
return $this->first_name;
}
/**
* Card holder's last name.
* Set Last Name
* Card holder's last name
*
* @param string $last_name
*
* @return $this
*/
public function setLastName($last_name) {
public function setLastName($last_name)
{
$this->last_name = $last_name;
return $this;
}
/**
* Card holder's last name.
* Get Last Name
* Card holder's last name
*
* @return string
*/
public function getLastName() {
public function getLastName()
{
return $this->last_name;
}
/**
* Card holder's last name.
* Set Last Name
* Card holder's last name
*
* @param string $last_name
* @deprecated. Instead use setLastName
*
* @deprecated Use setLastName
*
* @return $this
*/
public function setLast_name($last_name) {
public function setLast_name($last_name)
{
$this->last_name = $last_name;
return $this;
}
/**
* Card holder's last name.
* Get Last Name
* Card holder's last name
*
* @deprecated Use getLastName
*
* @return string
* @deprecated. Instead use getLastName
*/
public function getLast_name() {
public function getLast_name()
{
return $this->last_name;
}
/**
* Billing Address associated with this card.
* @param PayPal\Api\Address $billing_address
* Set Billing Address associated with this card
*
* @param \PayPal\Api\Address $billing_address
*
* @return $this
*/
public function setBillingAddress($billing_address) {
public function setBillingAddress($billing_address)
{
$this->billing_address = $billing_address;
return $this;
}
/**
* Billing Address associated with this card.
* @return PayPal\Api\Address
* Billing Address associated with this card
*
* @return \PayPal\Api\Address
*/
public function getBillingAddress() {
public function getBillingAddress()
{
return $this->billing_address;
}
/**
* Billing Address associated with this card.
* @param PayPal\Api\Address $billing_address
* @deprecated. Instead use setBillingAddress
* Set Billing Address associated with this card
*
* @param \PayPal\Api\Address $billing_address
*
* @deprecated Use setBillingAddress
*
* @return $this
*/
public function setBilling_address($billing_address) {
public function setBilling_address($billing_address)
{
$this->billing_address = $billing_address;
return $this;
}
/**
* Billing Address associated with this card.
* @return PayPal\Api\Address
* @deprecated. Instead use getBillingAddress
* Billing Address associated with this card
*
* @deprecated Use getBillingAddress
*
* @return \PayPal\Api\Address
*/
public function getBilling_address() {
public function getBilling_address()
{
return $this->billing_address;
}
/**
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
* Set Payer ID
* A unique identifier of the payer generated and provided by the facilitator
* This is required when creating or using a tokenized funding instrument
*
* @param string $payer_id
*
* @return $this
*/
public function setPayerId($payer_id) {
public function setPayerId($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
* Get Payer ID
* A unique identifier of the payer generated and provided by the facilitator
* This is required when creating or using a tokenized funding instrument
*
* @return string
*/
public function getPayerId() {
public function getPayerId()
{
return $this->payer_id;
}
/**
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
* Set Payer ID
* A unique identifier of the payer generated and provided by the facilitator
* This is required when creating or using a tokenized funding instrument
*
* @param string $payer_id
* @deprecated. Instead use setPayerId
*
* @deprecated Use setPayerId
*
* @return $this
*/
public function setPayer_id($payer_id) {
public function setPayer_id($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument.
* Get Payer ID
* A unique identifier of the payer generated and provided by the facilitator
* This is required when creating or using a tokenized funding instrument
*
* @deprecated Use getPayerId
*
* @return string
* @deprecated. Instead use getPayerId
*/
public function getPayer_id() {
public function getPayer_id()
{
return $this->payer_id;
}
/**
* State of the funding instrument.
* Set State
* State of the funding instrument
*
* @param string $state
*
* @return $this
*/
public function setState($state) {
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* State of the funding instrument.
* Get State
* State of the funding instrument
*
* @return string
*/
public function getState() {
public function getState()
{
return $this->state;
}
/**
* Date/Time until this resource can be used fund a payment.
* @param string $valid_until
*/
public function setValidUntil($valid_until) {
$this->valid_until = $valid_until;
return $this;
}
/**
* Date/Time until this resource can be used fund a payment.
* @return string
*/
public function getValidUntil() {
return $this->valid_until;
}
/**
* Date/Time until this resource can be used fund a payment.
* @param string $valid_until
* @deprecated. Instead use setValidUntil
*/
public function setValid_until($valid_until) {
$this->valid_until = $valid_until;
return $this;
}
/**
* Date/Time until this resource can be used fund a payment.
* @return string
* @deprecated. Instead use getValidUntil
*/
public function getValid_until() {
return $this->valid_until;
}
/**
* Set Valid Until
* Date/Time until this resource can be used fund a payment
*
* @array
* @param PayPal\Api\Links $links
* @param string $valid_until
*
* @return $this
*/
public function setLinks($links) {
public function setValidUntil($valid_until)
{
$this->valid_until = $valid_until;
return $this;
}
/**
* Get Valid Until
* Date/Time until this resource can be used fund a payment
*
* @return string
*/
public function getValidUntil()
{
return $this->valid_until;
}
/**
* Set Valid Until
* Date/Time until this resource can be used fund a payment
*
* @param string $valid_until
*
* @deprecated Use setValidUntil
*
* @return $this
*/
public function setValid_until($valid_until)
{
$this->valid_until = $valid_until;
return $this;
}
/**
* Get Valid Until
* Date/Time until this resource can be used fund a payment
*
* @deprecated Use getValidUntil
*
* @return string
*/
public function getValid_until()
{
return $this->valid_until;
}
/**
* Set Links
*
* @param \PayPal\Api\Links $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
*
* @return PayPal\Api\Links
* @return \PayPal\Api\Links
*/
public function getLinks() {
public function getLinks()
{
return $this->links;
}
public function create($apiContext = null) {
/**
* Create
*
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return $this
*/
public function create($apiContext = null)
{
$payLoad = $this->toJSON();
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card", "POST", $payLoad);
$this->fromJson($json);
return $this;
}
public static function get($creditCardId, $apiContext = null) {
/**
* Get
*
* @param int $creditCardId
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return CreditCard
* @throws \InvalidArgumentException
*/
public static function get($creditCardId, $apiContext = null)
{
if (($creditCardId == null) || (strlen($creditCardId) <= 0)) {
throw new \InvalidArgumentException("creditCardId cannot be null or empty");
}
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/$creditCardId", "GET", $payLoad);
$ret = new CreditCard();
$ret->fromJson($json);
return $ret;
}
public function delete($apiContext = null) {
/**
* Delete
*
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return bool
* @throws \InvalidArgumentException
*/
public function delete($apiContext = null)
{
if ($this->getId() == null) {
throw new \InvalidArgumentException("Id cannot be null");
}
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/{$this->getId()}", "DELETE", $payLoad);
$call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/{$this->getId()}", "DELETE", $payLoad);
return true;
}
}

123
lib/PayPal/Api/CreditCardHistory.php
View File

@@ -1,97 +1,154 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class CreditCardHistory extends PPModel {
/**
* A list of credit card resources
* @array
* @param PayPal\Api\CreditCard $credit-cards
/**
* Class CreditCardHistory
*
* @property int count
* @property string next_id
*/
public function setCreditCards($credit_cards) {
class CreditCardHistory extends PPModel
{
/**
* Set Credit Cards
* A list of credit card resources
*
* @param \PayPal\Api\CreditCard $credit_cards
*
* @return $this
*/
public function setCreditCards($credit_cards)
{
$this->{"credit-cards"} = $credit_cards;
return $this;
}
/**
* Get Credit Cards
* A list of credit card resources
* @return PayPal\Api\CreditCard
*
* @return \PayPal\Api\CreditCard
*/
public function getCreditCards() {
public function getCreditCards()
{
return $this->{"credit-cards"};
}
/**
* Set Credit Cards
* A list of credit card resources
* @array
* @param PayPal\Api\CreditCard $credit-cards
* @deprecated. Instead use setCreditCards
*
* @param \PayPal\Api\CreditCard $credit_cards
*
* @deprecated Use setCreditCards
*
* @return $this
*/
public function setCredit_cards($credit_cards) {
public function setCredit_cards($credit_cards)
{
$this->{"credit-cards"} = $credit_cards;
return $this;
}
/**
* Get Credit Cards
* A list of credit card resources
* @return PayPal\Api\CreditCard
* @deprecated. Instead use getCreditCards
*
* @deprecated Use getCreditCards
*
* @return \PayPal\Api\CreditCard
*/
public function getCredit_cards() {
public function getCredit_cards()
{
return $this->{"credit-cards"};
}
/**
* Number of items returned in each range of results. Note that the last results range could have fewer items than the requested number of items.
* @param integer $count
* Set Count
* Number of items returned in each range of results
* Note that the last results range could have fewer items than the requested number of items
*
* @param int $count
*
* @return $this
*/
public function setCount($count) {
public function setCount($count)
{
$this->count = $count;
return $this;
}
/**
* Number of items returned in each range of results. Note that the last results range could have fewer items than the requested number of items.
* @return integer
* Set Count
* Number of items returned in each range of results
* Note that the last results range could have fewer items than the requested number of items
*
* @return int
*/
public function getCount() {
public function getCount()
{
return $this->count;
}
/**
* Identifier of the next element to get the next range of results.
* Set Next ID
* Identifier of the next element to get the next range of results
*
* @param string $next_id
*
* @return $this
*/
public function setNextId($next_id) {
public function setNextId($next_id)
{
$this->next_id = $next_id;
return $this;
}
/**
* Identifier of the next element to get the next range of results.
* Get Next ID
* Identifier of the next element to get the next range of results
*
* @return string
*/
public function getNextId() {
public function getNextId()
{
return $this->next_id;
}
/**
* Identifier of the next element to get the next range of results.
* Set Next ID
* Identifier of the next element to get the next range of results
*
* @param string $next_id
* @deprecated. Instead use setNextId
*
* @deprecated Use setNextId
*
* @return $this
*/
public function setNext_id($next_id) {
public function setNext_id($next_id)
{
$this->next_id = $next_id;
return $this;
}
/**
* Identifier of the next element to get the next range of results.
* Get Next ID
* Identifier of the next element to get the next range of results
*
* @deprecated Use getNextId
*
* @return string
* @deprecated. Instead use getNextId
*/
public function getNext_id() {
public function getNext_id()
{
return $this->next_id;
}
}

229
lib/PayPal/Api/CreditCardToken.php
View File

@@ -1,183 +1,296 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class CreditCardToken extends PPModel {
/**
* ID of a previously saved Credit Card resource using /vault/credit-card API.
* @param string $credit_card_id
/**
* Class CreditCardToken
*
* @property string credit_card_id
* @property string payer_id
* @property string last4
* @property string type
* @property int expire_month
* @property int expire_year
*/
public function setCreditCardId($credit_card_id) {
class CreditCardToken extends PPModel
{
/**
* Set Credit Card ID
* ID of a previously saved Credit Card resource using /vault/credit-card API
*
* @param string $credit_card_id
*
* @return $this
*/
public function setCreditCardId($credit_card_id)
{
$this->credit_card_id = $credit_card_id;
return $this;
}
/**
* ID of a previously saved Credit Card resource using /vault/credit-card API.
* Get Credit Card ID
* ID of a previously saved Credit Card resource using /vault/credit-card API
*
* @return string
*/
public function getCreditCardId() {
public function getCreditCardId()
{
return $this->credit_card_id;
}
/**
* ID of a previously saved Credit Card resource using /vault/credit-card API.
* Set Credit Card ID
* ID of a previously saved Credit Card resource using /vault/credit-card API
*
* @param string $credit_card_id
* @deprecated. Instead use setCreditCardId
*
* @deprecated Use setCreditCardId
*
* @return $this
*/
public function setCredit_card_id($credit_card_id) {
public function setCredit_card_id($credit_card_id)
{
$this->credit_card_id = $credit_card_id;
return $this;
}
/**
* ID of a previously saved Credit Card resource using /vault/credit-card API.
* Get Credit Card ID
* ID of a previously saved Credit Card resource using /vault/credit-card API
*
* @deprecated Use getCreditCardId
*
* @return string
* @deprecated. Instead use getCreditCardId
*/
public function getCredit_card_id() {
public function getCredit_card_id()
{
return $this->credit_card_id;
}
/**
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API.
* Set Payer ID
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API
*
* @param string $payer_id
*
* @return $this
*/
public function setPayerId($payer_id) {
public function setPayerId($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API.
* Get Payer ID
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API
*
* @return string
*/
public function getPayerId() {
public function getPayerId()
{
return $this->payer_id;
}
/**
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API.
* Set Payer ID
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API
*
* @param string $payer_id
* @deprecated. Instead use setPayerId
*
* @deprecated Use setPayerId
*
* @return $this
*/
public function setPayer_id($payer_id) {
public function setPayer_id($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API.
* Get Payer ID
* The unique identifier of the payer used when saving this credit card using /vault/credit-card API
*
* @deprecated Use getPayerId
*
* @return string
* @deprecated. Instead use getPayerId
*/
public function getPayer_id() {
public function getPayer_id()
{
return $this->payer_id;
}
/**
* Last 4 digits of the card number from the saved card.
* Set Last Four
* Last 4 digits of the card number from the saved card
*
* @param string $last4
*
* @return $this
*/
public function setLast4($last4) {
public function setLast4($last4)
{
$this->last4 = $last4;
return $this;
}
/**
* Last 4 digits of the card number from the saved card.
* Get Last Four
* Last 4 digits of the card number from the saved card
*
* @return string
*/
public function getLast4() {
public function getLast4()
{
return $this->last4;
}
/**
* Type of the Card (eg. visa, mastercard, etc.) from the saved card. Please note that the values are always in lowercase and not meant to be used directly for display.
* Set Type
* (eg. visa, mastercard, etc) from the saved card
* Please note that the values are always in lowercase and not meant to be used directly for display
*
* @param string $type
*
* @return $this
*/
public function setType($type) {
public function setType($type)
{
$this->type = $type;
return $this;
}
/**
* Type of the Card (eg. visa, mastercard, etc.) from the saved card. Please note that the values are always in lowercase and not meant to be used directly for display.
* Get Type
* (eg. visa, mastercard, etc) from the saved card
* Please note that the values are always in lowercase and not meant to be used directly for display
*
* @return string
*/
public function getType() {
public function getType()
{
return $this->type;
}
/**
* card expiry month from the saved card with value 1 - 12
* @param integer $expire_month
* Set Expire Month
* Card Expiration month from the saved card with value 1 - 12
*
* @param int $expire_month
*
* @return $this
*/
public function setExpireMonth($expire_month) {
public function setExpireMonth($expire_month)
{
$this->expire_month = $expire_month;
return $this;
}
/**
* card expiry month from the saved card with value 1 - 12
* @return integer
* Get Expire Month
* Card Expiration month from the saved card with value 1 - 12
*
* @return int
*/
public function getExpireMonth() {
public function getExpireMonth()
{
return $this->expire_month;
}
/**
* card expiry month from the saved card with value 1 - 12
* @param integer $expire_month
* @deprecated. Instead use setExpireMonth
* Set Expire Month
* Card Expiration month from the saved card with value 1 - 12
*
* @param int $expire_month
*
* @deprecated Use setExpireMonth
*
* @return $this
*/
public function setExpire_month($expire_month) {
public function setExpire_month($expire_month)
{
$this->expire_month = $expire_month;
return $this;
}
/**
* card expiry month from the saved card with value 1 - 12
* @return integer
* @deprecated. Instead use getExpireMonth
* Get Expire Month
* Card Expiration month from the saved card with value 1 - 12
*
* @deprecated Use getExpireMonth
*
* @return int
*/
public function getExpire_month() {
public function getExpire_month()
{
return $this->expire_month;
}
/**
* Set Expire Year
* 4 digit card expiry year from the saved card
* @param integer $expire_year
*
* @param int $expire_year
*
* @return $this
*/
public function setExpireYear($expire_year) {
public function setExpireYear($expire_year)
{
$this->expire_year = $expire_year;
return $this;
}
/**
* Get Expire Year
* 4 digit card expiry year from the saved card
* @return integer
*
* @return int
*/
public function getExpireYear() {
public function getExpireYear()
{
return $this->expire_year;
}
/**
* Set Expire Year
* 4 digit card expiry year from the saved card
* @param integer $expire_year
* @deprecated. Instead use setExpireYear
*
* @param int $expire_year
*
* @deprecated Use setExpireYear
*
* @return $this
*/
public function setExpire_year($expire_year) {
public function setExpire_year($expire_year)
{
$this->expire_year = $expire_year;
return $this;
}
/**
* Get Expire Year
* 4 digit card expiry year from the saved card
* @return integer
* @deprecated. Instead use getExpireYear
*
* @deprecated Use getExpireYear
*
* @return int
*/
public function getExpire_year() {
public function getExpire_year()
{
return $this->expire_year;
}
}

91
lib/PayPal/Api/Details.php
View File

@@ -1,79 +1,122 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Details extends PPModel {
/**
* Amount being charged for shipping.
* @param string $shipping
/**
* Class Details
*
* @property string shipping
* @property string subtotal
* @property string tax
* @property string fee
*/
public function setShipping($shipping) {
class Details extends PPModel
{
/**
* Set Shipping
* Amount being charged for shipping
*
* @param string $shipping
*
* @return $this
*/
public function setShipping($shipping)
{
$this->shipping = $shipping;
return $this;
}
/**
* Amount being charged for shipping.
* Get Shipping
* Amount being charged for shipping
*
* @return string
*/
public function getShipping() {
public function getShipping()
{
return $this->shipping;
}
/**
* Sub-total (amount) of items being paid for.
* Set Subtotal
* Sub-total (amount) of items being paid for
*
* @param string $subtotal
*
* @return $this
*/
public function setSubtotal($subtotal) {
public function setSubtotal($subtotal)
{
$this->subtotal = $subtotal;
return $this;
}
/**
* Sub-total (amount) of items being paid for.
* Get Subtotal
* Sub-total (amount) of items being paid for
*
* @return string
*/
public function getSubtotal() {
public function getSubtotal()
{
return $this->subtotal;
}
/**
* Amount being charged as tax.
* Set Tax
* Amount being charged as tax
*
* @param string $tax
*
* @return $this
*/
public function setTax($tax) {
public function setTax($tax)
{
$this->tax = $tax;
return $this;
}
/**
* Amount being charged as tax.
* Get Tax
* Amount being charged as tax
*
* @return string
*/
public function getTax() {
public function getTax()
{
return $this->tax;
}
/**
* Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.
* Set Fee
* Fee charged by PayPal
* In case of a refund, this is the fee amount refunded to the original receipient of the payment
*
* @param string $fee
*
* @return $this
*/
public function setFee($fee) {
public function setFee($fee)
{
$this->fee = $fee;
return $this;
}
/**
* Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.
* Get Fee
* Fee charged by PayPal
* In case of a refund, this is the fee amount refunded to the original receipient of the payment
*
* @return string
*/
public function getFee() {
public function getFee()
{
return $this->fee;
}
}

103
lib/PayPal/Api/FundingInstrument.php
View File

@@ -1,77 +1,118 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class FundingInstrument extends PPModel {
/**
* Credit Card information.
* @param PayPal\Api\CreditCard $credit_card
/**
* Class FundingInstrument
*
* @property \PayPal\Api\CreditCard credit_card
* @property \PayPal\Api\CreditCardToken credit_card_token
*/
public function setCreditCard($credit_card) {
class FundingInstrument extends PPModel
{
/**
* Set Credit Card
*
* @param \PayPal\Api\CreditCard $credit_card
*
* @return $this
*/
public function setCreditCard($credit_card)
{
$this->credit_card = $credit_card;
return $this;
}
/**
* Credit Card information.
* @return PayPal\Api\CreditCard
* Get Credit Card
*
* @return \PayPal\Api\CreditCard
*/
public function getCreditCard() {
public function getCreditCard()
{
return $this->credit_card;
}
/**
* Credit Card information.
* @param PayPal\Api\CreditCard $credit_card
* @deprecated. Instead use setCreditCard
* Set Credit Card
*
* @param \PayPal\Api\CreditCard $credit_card
*
* @deprecated Use setCreditCard
*
* @return $this
*/
public function setCredit_card($credit_card) {
public function setCredit_card($credit_card)
{
$this->credit_card = $credit_card;
return $this;
}
/**
* Credit Card information.
* @return PayPal\Api\CreditCard
* @deprecated. Instead use getCreditCard
* Get Credit Card
*
* @deprecated Use getCreditCard
*
* @return \PayPal\Api\CreditCard
*/
public function getCredit_card() {
public function getCredit_card()
{
return $this->credit_card;
}
/**
* Credit Card information.
* @param PayPal\Api\CreditCardToken $credit_card_token
* Set Credit Card Token
*
* @param \PayPal\Api\CreditCardToken $credit_card_token
*
* @return $this
*/
public function setCreditCardToken($credit_card_token) {
public function setCreditCardToken($credit_card_token)
{
$this->credit_card_token = $credit_card_token;
return $this;
}
/**
* Credit Card information.
* @return PayPal\Api\CreditCardToken
* Get Credit Card Token
*
* @return \PayPal\Api\CreditCardToken
*/
public function getCreditCardToken() {
public function getCreditCardToken()
{
return $this->credit_card_token;
}
/**
* Credit Card information.
* @param PayPal\Api\CreditCardToken $credit_card_token
* @deprecated. Instead use setCreditCardToken
* Set Credit Card Token
*
* @param \PayPal\Api\CreditCardToken $credit_card_token
*
* @deprecated Use setCreditCardToken
*
* @return $this
*/
public function setCredit_card_token($credit_card_token) {
public function setCredit_card_token($credit_card_token)
{
$this->credit_card_token = $credit_card_token;
return $this;
}
/**
* Credit Card information.
* @return PayPal\Api\CreditCardToken
* @deprecated. Instead use getCreditCardToken
* Get Credit Card Token
*
* @deprecated Use getCreditCardToken
*
* @return \PayPal\Api\CreditCardToken
*/
public function getCredit_card_token() {
public function getCredit_card_token()
{
return $this->credit_card_token;
}
}

98
lib/PayPal/Api/HyperSchema.php
View File

@@ -1,116 +1,162 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class HyperSchema extends PPModel {
/**
/**
* Class HyperSchema
*
* @array
* @param PayPal\Api\Links $links
* @property \PayPal\Api\Links links
* @property string fragmentResolution
* @property bool readonly
* @property string contentEncoding
* @property string pathStart
* @property string mediaType
*/
public function setLinks($links) {
class HyperSchema extends PPModel
{
/**
* Set Links
*
* @param \PayPal\Api\Links $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
*
* @return PayPal\Api\Links
* @return \PayPal\Api\Links
*/
public function getLinks() {
public function getLinks()
{
return $this->links;
}
/**
* Set Fragment Resolution
*
* @param string $fragmentResolution
*
* @return $this
*/
public function setFragmentResolution($fragmentResolution) {
public function setFragmentResolution($fragmentResolution)
{
$this->fragmentResolution = $fragmentResolution;
return $this;
}
/**
* Get Fragment Resolution
*
* @return string
*/
public function getFragmentResolution() {
public function getFragmentResolution()
{
return $this->fragmentResolution;
}
/**
* Set Read Only
*
* @param boolean $readonly
* @param bool $readonly
*
* @return $this
*/
public function setReadonly($readonly) {
public function setReadonly($readonly)
{
$this->readonly = $readonly;
return $this;
}
/**
* Get Read Only
*
* @return boolean
* @return bool
*/
public function getReadonly() {
public function getReadonly()
{
return $this->readonly;
}
/**
* Set Content Encoding
*
* @param string $contentEncoding
*
* @return $this
*/
public function setContentEncoding($contentEncoding) {
public function setContentEncoding($contentEncoding)
{
$this->contentEncoding = $contentEncoding;
return $this;
}
/**
* Get Content Encoding
*
* @return string
*/
public function getContentEncoding() {
public function getContentEncoding()
{
return $this->contentEncoding;
}
/**
* Set Path Start
*
* @param string $pathStart
*
* @return $this
*/
public function setPathStart($pathStart) {
public function setPathStart($pathStart)
{
$this->pathStart = $pathStart;
return $this;
}
/**
* Get Path Start
*
* @return string
*/
public function getPathStart() {
public function getPathStart()
{
return $this->pathStart;
}
/**
* Set Media Type
*
* @param string $mediaType
*
* @return $this
*/
public function setMediaType($mediaType) {
public function setMediaType($mediaType)
{
$this->mediaType = $mediaType;
return $this;
}
/**
* Get Media Type
*
* @return string
*/
public function getMediaType() {
public function getMediaType()
{
return $this->mediaType;
}
}

108
lib/PayPal/Api/Item.php
View File

@@ -1,97 +1,147 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Item extends PPModel {
/**
* Number of items.
* @param string $quantity
/**
* Class Item
*
* @property string quantity
* @property string name
* @property string price
* @property string currency
* @property string sku
*/
public function setQuantity($quantity) {
class Item extends PPModel
{
/**
* Set Quantity
* Number of items
*
* @param string $quantity
*
* @return $this
*/
public function setQuantity($quantity)
{
$this->quantity = $quantity;
return $this;
}
/**
* Number of items.
* Get Quantity
* Number of items
*
* @return string
*/
public function getQuantity() {
public function getQuantity()
{
return $this->quantity;
}
/**
* Name of the item.
* Set Name
* Name of the item
*
* @param string $name
*
* @return $this
*/
public function setName($name) {
public function setName($name)
{
$this->name = $name;
return $this;
}
/**
* Name of the item.
* Get Name
* Name of the item
*
* @return string
*/
public function getName() {
public function getName()
{
return $this->name;
}
/**
* Cost of the item.
* Set Price
* Cost of the item
*
* @param string $price
*
* @return $this
*/
public function setPrice($price) {
public function setPrice($price)
{
$this->price = $price;
return $this;
}
/**
* Cost of the item.
* Get Price
* Cost of the item
*
* @return string
*/
public function getPrice() {
public function getPrice()
{
return $this->price;
}
/**
* 3-letter Currency Code
* Set Currency
* Three Letter Currency Code
*
* @param string $currency
*
* @return $this
*/
public function setCurrency($currency) {
public function setCurrency($currency)
{
$this->currency = $currency;
return $this;
}
/**
* 3-letter Currency Code
* Get Currency
* Three Letter Currency Code
*
* @return string
*/
public function getCurrency() {
public function getCurrency()
{
return $this->currency;
}
/**
* Number or code to identify the item in your catalog/records.
* Set SKU
* Number or code to identify the item in your catalog/records
*
* @param string $sku
*
* @return $this
*/
public function setSku($sku) {
public function setSku($sku)
{
$this->sku = $sku;
return $this;
}
/**
* Number or code to identify the item in your catalog/records.
* Get SKI
* Number or code to identify the item in your catalog/records
*
* @return string
*/
public function getSku() {
public function getSku()
{
return $this->sku;
}
}

81
lib/PayPal/Api/ItemList.php
View File

@@ -1,61 +1,92 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class ItemList extends PPModel {
/**
* List of items.
* @array
* @param PayPal\Api\Item $items
/**
* Class ItemList
*
* @property array|\PayPal\Api\Item items
* @property \PayPal\Api\ShippingAddress shipping_address
*/
public function setItems($items) {
class ItemList extends PPModel
{
/**
* Set Items
* List of Items
*
* @param array|\PayPal\Api\Item $items
*
* @return $this
*/
public function setItems($items)
{
$this->items = $items;
return $this;
}
/**
* List of items.
* @return PayPal\Api\Item
* Get Items
* List of items
*
* @return \PayPal\Api\Item
*/
public function getItems() {
public function getItems()
{
return $this->items;
}
/**
* Shipping address.
* @param PayPal\Api\ShippingAddress $shipping_address
* Set Shipping Address
*
* @param \PayPal\Api\ShippingAddress $shipping_address
*
* @return $this
*/
public function setShippingAddress($shipping_address) {
public function setShippingAddress($shipping_address)
{
$this->shipping_address = $shipping_address;
return $this;
}
/**
* Shipping address.
* @return PayPal\Api\ShippingAddress
* Get Shipping Address
*
* @return \PayPal\Api\ShippingAddress
*/
public function getShippingAddress() {
public function getShippingAddress()
{
return $this->shipping_address;
}
/**
* Shipping address.
* @param PayPal\Api\ShippingAddress $shipping_address
* @deprecated. Instead use setShippingAddress
* Set Shipping Address
*
* @param \PayPal\Api\ShippingAddress $shipping_address
*
* @deprecated Use setShippingAddress
*
* @return $this
*/
public function setShipping_address($shipping_address) {
public function setShipping_address($shipping_address)
{
$this->shipping_address = $shipping_address;
return $this;
}
/**
* Shipping address.
* @return PayPal\Api\ShippingAddress
* @deprecated. Instead use getShippingAddress
* Get Shipping Address
*
* @deprecated Use getShippingAddress
*
* @return \PayPal\Api\ShippingAddress
*/
public function getShipping_address() {
public function getShipping_address()
{
return $this->shipping_address;
}
}

95
lib/PayPal/Api/Links.php
View File

@@ -1,115 +1,162 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Links extends PPModel {
/**
* Class Links
*
* @property string href
* @property string rel
* @property \PayPal\Api\HyperSchema targetSchema
* @property string method
* @property string enctype
* @property \PayPal\Api\HyperSchema schema
*/
class Links extends PPModel
{
/**
* Set Href
*
* @param string $href
*
* @return $this
*/
public function setHref($href) {
public function setHref($href)
{
$this->href = $href;
return $this;
}
/**
* Get Href
*
* @return string
*/
public function getHref() {
public function getHref()
{
return $this->href;
}
/**
* Set Rel
*
* @param string $rel
*
* @return $this
*/
public function setRel($rel) {
public function setRel($rel)
{
$this->rel = $rel;
return $this;
}
/**
* Get Rel
*
* @return string
*/
public function getRel() {
public function getRel()
{
return $this->rel;
}
/**
* Set Target Schema
*
* @param PayPal\Api\HyperSchema $targetSchema
* @param \PayPal\Api\HyperSchema $targetSchema
*
* @return $this
*/
public function setTargetSchema($targetSchema) {
public function setTargetSchema($targetSchema)
{
$this->targetSchema = $targetSchema;
return $this;
}
/**
* Get Target Schema
*
* @return PayPal\Api\HyperSchema
* @return \PayPal\Api\HyperSchema
*/
public function getTargetSchema() {
public function getTargetSchema()
{
return $this->targetSchema;
}
/**
* Set Method
*
* @param string $method
*
* @return $this
*/
public function setMethod($method) {
public function setMethod($method)
{
$this->method = $method;
return $this;
}
/**
* Get Method
*
* @return string
*/
public function getMethod() {
public function getMethod()
{
return $this->method;
}
/**
* Set Enctype
*
* @param string $enctype
*
* @return $this
*/
public function setEnctype($enctype) {
public function setEnctype($enctype)
{
$this->enctype = $enctype;
return $this;
}
/**
* Get Enctype
*
* @return string
*/
public function getEnctype() {
public function getEnctype()
{
return $this->enctype;
}
/**
* Set Schema
*
* @param PayPal\Api\HyperSchema $schema
* @param \PayPal\Api\HyperSchema $schema
*
* @return $this
*/
public function setSchema($schema) {
public function setSchema($schema)
{
$this->schema = $schema;
return $this;
}
/**
* Get Schema
*
* @return PayPal\Api\HyperSchema
* @return \PayPal\Api\HyperSchema
*/
public function getSchema() {
public function getSchema()
{
return $this->schema;
}
}

101
lib/PayPal/Api/Payee.php
View File

@@ -1,78 +1,131 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Payee extends PPModel {
/**
* Email Address associated with the Payee's PayPal Account. If the provided email address is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments. Direct Credit Card Payments will be denied due to card compliance requirements.
* @param string $email
/**
* Class Payee
*
* @property string email
* @property string merchant_id
* @property string phone
*/
public function setEmail($email) {
class Payee extends PPModel
{
/**
* Set Email
* Email Address associated with the Payee's PayPal Account
* If the provided email address is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments
* Direct Credit Card Payments will be denied due to card compliance requirements
*
* @param string $email
*
* @return $this
*/
public function setEmail($email)
{
$this->email = $email;
return $this;
}
/**
* Email Address associated with the Payee's PayPal Account. If the provided email address is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments. Direct Credit Card Payments will be denied due to card compliance requirements.
* Get Email
* Email Address associated with the Payee's PayPal Account
* If the provided email address is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments
* Direct Credit Card Payments will be denied due to card compliance requirements
*
* @return string
*/
public function getEmail() {
public function getEmail()
{
return $this->email;
}
/**
* Encrypted PayPal Account identifier for the Payee.
* Set Merchant ID
* Encrypted PayPal Account identifier for the Payee
*
* @param string $merchant_id
*
* @return $this
*/
public function setMerchantId($merchant_id) {
public function setMerchantId($merchant_id)
{
$this->merchant_id = $merchant_id;
return $this;
}
/**
* Encrypted PayPal Account identifier for the Payee.
* Get Merchant ID
* Encrypted PayPal Account identifier for the Payee
*
* @return string
*/
public function getMerchantId() {
public function getMerchantId()
{
return $this->merchant_id;
}
/**
* Encrypted PayPal Account identifier for the Payee.
* Set Merchant ID
* Encrypted PayPal Account identifier for the Payee
*
* @param string $merchant_id
* @deprecated. Instead use setMerchantId
*
* @deprecated Use setMerchantId
*
* @return $this
*/
public function setMerchant_id($merchant_id) {
public function setMerchant_id($merchant_id)
{
$this->merchant_id = $merchant_id;
return $this;
}
/**
* Encrypted PayPal Account identifier for the Payee.
* Get Merchant ID
* Encrypted PayPal Account identifier for the Payee
*
* @deprecated Use getMerchantId
*
* @return string
* @deprecated. Instead use getMerchantId
*/
public function getMerchant_id() {
public function getMerchant_id()
{
return $this->merchant_id;
}
/**
* Phone number (in E.123 format) associated with the Payee's PayPal Account. If the provided phont number is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments. Direct Credit Card Payments will be denied due to card compliance requirements.
* Set Phone
* (in E.123 format) associated with the Payee's PayPal Account
* If the provided phont number is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments
* Direct Credit Card Payments will be denied due to card compliance requirements
*
* @param string $phone
*
* @return $this
*/
public function setPhone($phone) {
public function setPhone($phone)
{
$this->phone = $phone;
return $this;
}
/**
* Phone number (in E.123 format) associated with the Payee's PayPal Account. If the provided phont number is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments. Direct Credit Card Payments will be denied due to card compliance requirements.
* Get Phone
* (in E.123 format) associated with the Payee's PayPal Account
* If the provided phont number is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments
* Direct Credit Card Payments will be denied due to card compliance requirements
*
* @return string
*/
public function getPhone() {
public function getPhone()
{
return $this->phone;
}
}

155
lib/PayPal/Api/Payer.php
View File

@@ -1,114 +1,181 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Payer extends PPModel {
/**
* Payment method being used - PayPal Wallet payment or Direct Credit card.
* @param string $payment_method
/**
* Class Payer
*
* @property string payment_method
* @property array|\PayPal\Api\FundingInstrument funding_instruments
* @property \PayPal\Api\PayerInfo payer_info
*/
public function setPaymentMethod($payment_method) {
class Payer extends PPModel
{
/**
* Set Payment Method
* Payment method being used - PayPal Wallet payment or Direct Credit card
*
* @param string $payment_method
*
* @return $this
*/
public function setPaymentMethod($payment_method)
{
$this->payment_method = $payment_method;
return $this;
}
/**
* Payment method being used - PayPal Wallet payment or Direct Credit card.
* Get Payment Method
* Payment method being used - PayPal Wallet payment or Direct Credit card
*
* @return string
*/
public function getPaymentMethod() {
public function getPaymentMethod()
{
return $this->payment_method;
}
/**
* Payment method being used - PayPal Wallet payment or Direct Credit card.
* Set Payment Method
* Payment method being used - PayPal Wallet payment or Direct Credit card
*
* @param string $payment_method
* @deprecated. Instead use setPaymentMethod
*
* @deprecated Use setPaymentMethod
*
* @return $this
*/
public function setPayment_method($payment_method) {
public function setPayment_method($payment_method)
{
$this->payment_method = $payment_method;
return $this;
}
/**
* Payment method being used - PayPal Wallet payment or Direct Credit card.
* Get Payment Method
* Payment method being used - PayPal Wallet payment or Direct Credit card
*
* @deprecated Use getPaymentMethod
*
* @return string
* @deprecated. Instead use getPaymentMethod
*/
public function getPayment_method() {
public function getPayment_method()
{
return $this->payment_method;
}
/**
* List of funding instruments from where the funds of the current payment come from. Typically a credit card.
* @array
* @param PayPal\Api\FundingInstrument $funding_instruments
* Set Funding Instruments
* List of funding instruments from where the funds of the current payment come from. Typically a credit card
*
* @param \PayPal\Api\FundingInstrument|array $funding_instruments
*
* @return $this
*/
public function setFundingInstruments($funding_instruments) {
public function setFundingInstruments($funding_instruments)
{
$this->funding_instruments = $funding_instruments;
return $this;
}
/**
* List of funding instruments from where the funds of the current payment come from. Typically a credit card.
* @return PayPal\Api\FundingInstrument
* Get Funding Instruments
*
* @return \PayPal\Api\FundingInstrument|array
*/
public function getFundingInstruments() {
public function getFundingInstruments()
{
return $this->funding_instruments;
}
/**
* List of funding instruments from where the funds of the current payment come from. Typically a credit card.
* @array
* @param PayPal\Api\FundingInstrument $funding_instruments
* @deprecated. Instead use setFundingInstruments
* Set Funding Instruments
* List of funding instruments from where the funds of the current payment come from. Typically a credit card
*
* @param \PayPal\Api\FundingInstrument $funding_instruments
*
* @deprecated Use setFundingInstruments
*
* @return $this
*/
public function setFunding_instruments($funding_instruments) {
public function setFunding_instruments($funding_instruments)
{
$this->funding_instruments = $funding_instruments;
return $this;
}
/**
* List of funding instruments from where the funds of the current payment come from. Typically a credit card.
* @return PayPal\Api\FundingInstrument
* @deprecated. Instead use getFundingInstruments
* Get Funding Instruments
*
* @deprecated Use getFundingInstruments
*
* @return \PayPal\Api\FundingInstrument
*/
public function getFunding_instruments() {
public function getFunding_instruments()
{
return $this->funding_instruments;
}
/**
* Information related to the Payer. In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet.
* @param PayPal\Api\PayerInfo $payer_info
* Set Payer Info
* Information related to the Payer
* In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet
*
* @param \PayPal\Api\PayerInfo $payer_info
*
* @return $this
*/
public function setPayerInfo($payer_info) {
public function setPayerInfo($payer_info)
{
$this->payer_info = $payer_info;
return $this;
}
/**
* Information related to the Payer. In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet.
* @return PayPal\Api\PayerInfo
* Get Payer Info
*
* @return \PayPal\Api\PayerInfo
*/
public function getPayerInfo() {
public function getPayerInfo()
{
return $this->payer_info;
}
/**
* Information related to the Payer. In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet.
* @param PayPal\Api\PayerInfo $payer_info
* @deprecated. Instead use setPayerInfo
* Set Payer Info
* Information related to the Payer
* In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet
*
* @param \PayPal\Api\PayerInfo $payer_info
*
* @deprecated Use setPayerInfo
*
* @return $this
*/
public function setPayer_info($payer_info) {
public function setPayer_info($payer_info)
{
$this->payer_info = $payer_info;
return $this;
}
/**
* Information related to the Payer. In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet.
* @return PayPal\Api\PayerInfo
* @deprecated. Instead use getPayerInfo
* Get Payer Info
*
* @deprecated Use getPayerInfo
*
* @return \PayPal\Api\PayerInfo
*/
public function getPayer_info() {
public function getPayer_info()
{
return $this->payer_info;
}
}

227
lib/PayPal/Api/PayerInfo.php
View File

@@ -1,183 +1,294 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class PayerInfo extends PPModel {
/**
* Email address representing the Payer.
* @param string $email
/**
* Class PayerInfo
*
* @property string email
* @property string first_name
* @property string last_name
* @property string payer_id
* @property string phone
* @property \PayPal\Api\Address shipping_address
*/
public function setEmail($email) {
class PayerInfo extends PPModel
{
/**
* Set Email
* Email address representing the Payer
*
* @param string $email
*
* @return $this
*/
public function setEmail($email)
{
$this->email = $email;
return $this;
}
/**
* Email address representing the Payer.
* Get Email
* Email address representing the Payer
*
* @return string
*/
public function getEmail() {
public function getEmail()
{
return $this->email;
}
/**
* First Name of the Payer from their PayPal Account.
* Set First Name
* First Name of the Payer from their PayPal Account
*
* @param string $first_name
*
* @return $this
*/
public function setFirstName($first_name) {
public function setFirstName($first_name)
{
$this->first_name = $first_name;
return $this;
}
/**
* First Name of the Payer from their PayPal Account.
* Get First Name
* First Name of the Payer from their PayPal Account
*
* @return string
*/
public function getFirstName() {
public function getFirstName()
{
return $this->first_name;
}
/**
* First Name of the Payer from their PayPal Account.
* Set First Name
* First Name of the Payer from their PayPal Account
*
* @param string $first_name
* @deprecated. Instead use setFirstName
*
* @deprecated Use setFirstName
*
* @return $this
*/
public function setFirst_name($first_name) {
public function setFirst_name($first_name)
{
$this->first_name = $first_name;
return $this;
}
/**
* First Name of the Payer from their PayPal Account.
* Get First Name
* First Name of the Payer from their PayPal Account
*
* @deprecated Use getFirstName
*
* @return string
* @deprecated. Instead use getFirstName
*/
public function getFirst_name() {
public function getFirst_name()
{
return $this->first_name;
}
/**
* Last Name of the Payer from their PayPal Account.
* Set Last Name
* Last Name of the Payer from their PayPal Account
*
* @param string $last_name
*
* @return $this
*/
public function setLastName($last_name) {
public function setLastName($last_name)
{
$this->last_name = $last_name;
return $this;
}
/**
* Last Name of the Payer from their PayPal Account.
* Get Last Name
* Last Name of the Payer from their PayPal Account
*
* @return string
*/
public function getLastName() {
public function getLastName()
{
return $this->last_name;
}
/**
* Last Name of the Payer from their PayPal Account.
* Set Last Name
* Last Name of the Payer from their PayPal Account
*
* @param string $last_name
* @deprecated. Instead use setLastName
*
* @deprecated Use setLastName
*
* @return $this
*/
public function setLast_name($last_name) {
public function setLast_name($last_name)
{
$this->last_name = $last_name;
return $this;
}
/**
* Last Name of the Payer from their PayPal Account.
* Get Last Name
* Last Name of the Payer from their PayPal Account
*
* @deprecated Use getLastName
*
* @return string
* @deprecated. Instead use getLastName
*/
public function getLast_name() {
public function getLast_name()
{
return $this->last_name;
}
/**
* PayPal assigned Payer ID.
* Set Payer ID
* PayPal assigned Payer ID
*
* @param string $payer_id
*
* @return $this
*/
public function setPayerId($payer_id) {
public function setPayerId($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* PayPal assigned Payer ID.
* Get Payer ID
* PayPal assigned Payer ID
*
* @return string
*/
public function getPayerId() {
public function getPayerId()
{
return $this->payer_id;
}
/**
* PayPal assigned Payer ID.
* Set Payer ID
* PayPal assigned Payer ID
*
* @param string $payer_id
* @deprecated. Instead use setPayerId
*
* @deprecated Use setPayerId
*
* @return $this
*/
public function setPayer_id($payer_id) {
public function setPayer_id($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* PayPal assigned Payer ID.
* Get Payer ID
* PayPal assigned Payer ID
*
* @deprecated Use setPayerId
*
* @return string
* @deprecated. Instead use getPayerId
*/
public function getPayer_id() {
public function getPayer_id()
{
return $this->payer_id;
}
/**
* Phone number representing the Payer.
* Set Phone
* Phone number representing the Payer
*
* @param string $phone
*
* @return $this
*/
public function setPhone($phone) {
public function setPhone($phone)
{
$this->phone = $phone;
return $this;
}
/**
* Phone number representing the Payer.
* Get Phone
* Phone number representing the Payer
*
* @return string
*/
public function getPhone() {
public function getPhone()
{
return $this->phone;
}
/**
* Shipping address of the Payer from their PayPal Account.
* @param PayPal\Api\Address $shipping_address
* Set Shipping Address
* Shipping address of the Payer from their PayPal Account
*
* @param \PayPal\Api\Address $shipping_address
*
* @return $this
*/
public function setShippingAddress($shipping_address) {
public function setShippingAddress($shipping_address)
{
$this->shipping_address = $shipping_address;
return $this;
}
/**
* Shipping address of the Payer from their PayPal Account.
* @return PayPal\Api\Address
* Get Shipping Address
* Shipping address of the Payer from their PayPal Account
*
* @return \PayPal\Api\Address
*/
public function getShippingAddress() {
public function getShippingAddress()
{
return $this->shipping_address;
}
/**
* Shipping address of the Payer from their PayPal Account.
* @param PayPal\Api\Address $shipping_address
* @deprecated. Instead use setShippingAddress
* Set Shipping Address
* Shipping address of the Payer from their PayPal Account
*
* @param \PayPal\Api\Address $shipping_address
*
* @deprecated Use setShippingAddress
*
* @return $this
*/
public function setShipping_address($shipping_address) {
public function setShipping_address($shipping_address)
{
$this->shipping_address = $shipping_address;
return $this;
}
/**
* Shipping address of the Payer from their PayPal Account.
* @return PayPal\Api\Address
* @deprecated. Instead use getShippingAddress
* Get Shipping Address
* Shipping address of the Payer from their PayPal Account
*
* @deprecated Use getShippingAddress
*
* @return \PayPal\Api\Address
*/
public function getShipping_address() {
public function getShipping_address()
{
return $this->shipping_address;
}
}

396
lib/PayPal/Api/Payment.php
View File

@@ -1,299 +1,491 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\IResource;
use PayPal\Rest\Call;
use PayPal\Rest\ApiContext;
use PayPal\Api\Payment;
use PayPal\Api\PaymentHistory;
use PayPal\Rest\IResource;
use PayPal\Transport\PPRestCall;
class Payment extends PPModel implements IResource {
/**
* Class Payment
*
* @property string id
* @property string create_time
* @property string update_time
* @property string intent
* @property \PayPal\Api\Payer payer
* @property array|\PayPal\Api\Transaction transactions
* @property string state
* @property \PayPal\Api\RedirectUrls redirect_urls
* @property \PayPal\Api\Links links
*/
class Payment extends PPModel implements IResource
{
/**
* @var
*/
private static $credential;
/**
* Set Credential
*
* @deprecated. Pass ApiContext to create/get methods instead
* @param $credential
*
* @deprecated Pass ApiContext to create/get methods instead
*/
public static function setCredential($credential) {
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* Identifier of the payment resource created.
* Set ID
* Identifier of the payment resource created
*
* @param string $id
*
* @return $this
*/
public function setId($id) {
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* Identifier of the payment resource created.
* Get ID
* Identifier of the payment resource created
*
* @return string
*/
public function getId() {
public function getId()
{
return $this->id;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
*
* @return $this
*/
public function setCreateTime($create_time) {
public function setCreateTime($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @return string
*/
public function getCreateTime() {
public function getCreateTime()
{
return $this->create_time;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
* @deprecated. Instead use setCreateTime
*
* @deprecated Use setCreateTime
*
* @return $this
*/
public function setCreate_time($create_time) {
public function setCreate_time($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @deprecated Use getCreateTime
*
* @return string
* @deprecated. Instead use getCreateTime
*/
public function getCreate_time() {
public function getCreate_time()
{
return $this->create_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
*
* @return $this
*/
public function setUpdateTime($update_time) {
public function setUpdateTime($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @return string
*/
public function getUpdateTime() {
public function getUpdateTime()
{
return $this->update_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
* @deprecated. Instead use setUpdateTime
*
* @deprecated Use setUpdateTime
*
* @return $this
*/
public function setUpdate_time($update_time) {
public function setUpdate_time($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @deprecated Use getUpdateTime
*
* @return string
* @deprecated. Instead use getUpdateTime
*/
public function getUpdate_time() {
public function getUpdate_time()
{
return $this->update_time;
}
/**
* Intent of the payment - Sale or Authorization or Order.
* Set Intent
* Intent of the payment - Sale or Authorization or Order
*
* @param string $intent
*
* @return $this
*/
public function setIntent($intent) {
public function setIntent($intent)
{
$this->intent = $intent;
return $this;
}
/**
* Intent of the payment - Sale or Authorization or Order.
* Get Intent
* Intent of the payment - Sale or Authorization or Order
*
* @return string
*/
public function getIntent() {
public function getIntent()
{
return $this->intent;
}
/**
* Source of the funds for this payment represented by a PayPal account or a direct credit card.
* @param PayPal\Api\Payer $payer
* Set Payer
* Source of the funds for this payment represented by a PayPal account or a direct credit card
*
* @param \PayPal\Api\Payer $payer
*
* @return $this
*/
public function setPayer($payer) {
public function setPayer($payer)
{
$this->payer = $payer;
return $this;
}
/**
* Source of the funds for this payment represented by a PayPal account or a direct credit card.
* @return PayPal\Api\Payer
* Get Payer
* Source of the funds for this payment represented by a PayPal account or a direct credit card
*
* @return \PayPal\Api\Payer
*/
public function getPayer() {
public function getPayer()
{
return $this->payer;
}
/**
* Set Transactions
* A payment can have more than one transaction, with each transaction establishing a contract between the payer and a payee
* @array
* @param PayPal\Api\Transaction $transactions
*
* @param array|\PayPal\Api\Transaction $transactions
*
* @return $this
*/
public function setTransactions($transactions) {
public function setTransactions($transactions)
{
$this->transactions = $transactions;
return $this;
}
/**
* Get Transactions
* A payment can have more than one transaction, with each transaction establishing a contract between the payer and a payee
* @return PayPal\Api\Transaction
*
* @return \PayPal\Api\Transaction
*/
public function getTransactions() {
public function getTransactions()
{
return $this->transactions;
}
/**
* state of the payment
* Set State
* State of the payment
*
* @param string $state
*
* @return $this
*/
public function setState($state) {
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* state of the payment
* Get State
* State of the payment
*
* @return string
*/
public function getState() {
public function getState()
{
return $this->state;
}
/**
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls.
* @param PayPal\Api\RedirectUrls $redirect_urls
*/
public function setRedirectUrls($redirect_urls) {
$this->redirect_urls = $redirect_urls;
return $this;
}
/**
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls.
* @return PayPal\Api\RedirectUrls
*/
public function getRedirectUrls() {
return $this->redirect_urls;
}
/**
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls.
* @param PayPal\Api\RedirectUrls $redirect_urls
* @deprecated. Instead use setRedirectUrls
*/
public function setRedirect_urls($redirect_urls) {
$this->redirect_urls = $redirect_urls;
return $this;
}
/**
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls.
* @return PayPal\Api\RedirectUrls
* @deprecated. Instead use getRedirectUrls
*/
public function getRedirect_urls() {
return $this->redirect_urls;
}
/**
* Set Redirect URLs
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls
*
* @array
* @param PayPal\Api\Links $links
* @param \PayPal\Api\RedirectUrls $redirect_urls
*
* @return $this
*/
public function setLinks($links) {
public function setRedirectUrls($redirect_urls)
{
$this->redirect_urls = $redirect_urls;
return $this;
}
/**
* Get Redirect URLs
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls
*
* @return \PayPal\Api\RedirectUrls
*/
public function getRedirectUrls()
{
return $this->redirect_urls;
}
/**
* Set Redirect URLs
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls
*
* @param \PayPal\Api\RedirectUrls $redirect_urls
*
* @deprecated Use setRedirectUrls
*
* @return $this
*/
public function setRedirect_urls($redirect_urls)
{
$this->redirect_urls = $redirect_urls;
return $this;
}
/**
* Get Redirect URLs
* Redirect urls required only when using payment_method as PayPal - the only settings supported are return and cancel urls
*
* @deprecated Use getRedirectUrls
*
* @return \PayPal\Api\RedirectUrls
*/
public function getRedirect_urls()
{
return $this->redirect_urls;
}
/**
* Set Links
*
* @param \PayPal\Api\Links $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
*
* @return PayPal\Api\Links
* @return \PayPal\Api\Links
*/
public function getLinks() {
public function getLinks()
{
return $this->links;
}
public function create($apiContext = null) {
/**
* Create
*
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return $this
*/
public function create($apiContext = null)
{
$payLoad = $this->toJSON();
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/payment", "POST", $payLoad);
$this->fromJson($json);
return $this;
}
public static function get($paymentId, $apiContext = null) {
/**
* Get
*
* @param int $paymentId
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return Payment
* @throws \InvalidArgumentException
*/
public static function get($paymentId, $apiContext = null)
{
if (($paymentId == null) || (strlen($paymentId) <= 0)) {
throw new \InvalidArgumentException("paymentId cannot be null or empty");
}
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/payment/$paymentId", "GET", $payLoad);
$ret = new Payment();
$ret->fromJson($json);
return $ret;
}
public function execute($paymentExecution, $apiContext = null) {
/**
* Execute
*
* @param \Paypal\Api\PaymentExecution $paymentExecution
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return Payment
* @throws \InvalidArgumentException
*/
public function execute($paymentExecution, $apiContext = null)
{
if ($this->getId() == null) {
throw new \InvalidArgumentException("Id cannot be null");
}
if (($paymentExecution == null)) {
throw new \InvalidArgumentException("paymentExecution cannot be null or empty");
}
$payLoad = $paymentExecution->toJSON();
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/payment/{$this->getId()}/execute", "POST", $payLoad);
$ret = new Payment();
$ret->fromJson($json);
return $ret;
}
public static function all($params, $apiContext = null) {
/**
* All
*
* @param array $params
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @return PaymentHistory
* @throws \InvalidArgumentException
*/
public static function all($params, $apiContext = null)
{
if (($params == null)) {
throw new \InvalidArgumentException("params cannot be null or empty");
}
$payLoad = "";
$allowedParams = array('count' => 1, 'start_id' => 1, 'start_index' => 1, 'start_time' => 1, 'end_time' => 1, 'payee_id' => 1, 'sort_by' => 1, 'sort_order' => 1, );
$allowedParams = array(
'count' => 1,
'start_id' => 1,
'start_index' => 1,
'start_time' => 1,
'end_time' => 1,
'payee_id' => 1,
'sort_by' => 1,
'sort_order' => 1,
);
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/payment?" . http_build_query(array_intersect_key($params, $allowedParams)), "GET", $payLoad);
$ret = new PaymentHistory();
$ret->fromJson($json);
return $ret;
}
}

79
lib/PayPal/Api/PaymentExecution.php
View File

@@ -1,61 +1,96 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class PaymentExecution extends PPModel {
/**
* PayPal assigned Payer ID returned in the approval return url.
* @param string $payer_id
/**
* Class PaymentExecution
*
* @property string payer_id
* @property \PayPal\Api\Transactions transactions
*/
public function setPayerId($payer_id) {
class PaymentExecution extends PPModel
{
/**
* Set Payer ID
* PayPal assigned Payer ID returned in the approval return url
*
* @param string $payer_id
*
* @return $this
*/
public function setPayerId($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* PayPal assigned Payer ID returned in the approval return url.
* Get Payer ID
* PayPal assigned Payer ID returned in the approval return url
*
* @return string
*/
public function getPayerId() {
public function getPayerId()
{
return $this->payer_id;
}
/**
* PayPal assigned Payer ID returned in the approval return url.
* Set Payer ID
* PayPal assigned Payer ID returned in the approval return url
*
* @param string $payer_id
* @deprecated. Instead use setPayerId
*
* @deprecated Use setPayerId
*
* @return $this
*/
public function setPayer_id($payer_id) {
public function setPayer_id($payer_id)
{
$this->payer_id = $payer_id;
return $this;
}
/**
* PayPal assigned Payer ID returned in the approval return url.
* Get Payer ID
* PayPal assigned Payer ID returned in the approval return url
*
* @deprecated Use getPayerId
*
* @return string
* @deprecated. Instead use getPayerId
*/
public function getPayer_id() {
public function getPayer_id()
{
return $this->payer_id;
}
/**
* If the amount needs to be updated after obtaining the PayPal Payer info (eg. shipping address), it can be updated using this element.
* @array
* @param PayPal\Api\Transactions $transactions
* Set Transactions
* If the amount needs to be updated after obtaining the PayPal Payer info (eg. shipping address), it can be updated using this element
*
* @param \PayPal\Api\Transactions $transactions
*
* @return $this
*/
public function setTransactions($transactions) {
public function setTransactions($transactions)
{
$this->transactions = $transactions;
return $this;
}
/**
* If the amount needs to be updated after obtaining the PayPal Payer info (eg. shipping address), it can be updated using this element.
* @return PayPal\Api\Transactions
* Get Transactions
* If the amount needs to be updated after obtaining the PayPal Payer info (eg. shipping address), it can be updated using this element
*
* @return \PayPal\Api\Transactions
*/
public function getTransactions() {
public function getTransactions()
{
return $this->transactions;
}
}

100
lib/PayPal/Api/PaymentHistory.php
View File

@@ -1,79 +1,125 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class PaymentHistory extends PPModel {
/**
* A list of Payment resources
* @array
* @param PayPal\Api\Payment $payments
/**
* Class PaymentHistory
*
* @property \PayPal\Api\Payment payments
* @property int count
* @property string next_id
*/
public function setPayments($payments) {
class PaymentHistory extends PPModel
{
/**
* Set Payments
* A list of Payment resources
*
* @param \PayPal\Api\Payment $payments
*
* @return $this
*/
public function setPayments($payments)
{
$this->payments = $payments;
return $this;
}
/**
* Get Payments
* A list of Payment resources
* @return PayPal\Api\Payment
*
* @return \PayPal\Api\Payment
*/
public function getPayments() {
public function getPayments()
{
return $this->payments;
}
/**
* Number of items returned in each range of results. Note that the last results range could have fewer items than the requested number of items.
* @param integer $count
* Set Count
* Number of items returned in each range of results
* Note that the last results range could have fewer items than the requested number of items
*
* @param int $count
*
* @return $this
*/
public function setCount($count) {
public function setCount($count)
{
$this->count = $count;
return $this;
}
/**
* Number of items returned in each range of results. Note that the last results range could have fewer items than the requested number of items.
* @return integer
* Get Count
* Number of items returned in each range of results
* Note that the last results range could have fewer items than the requested number of items
*
* @return int
*/
public function getCount() {
public function getCount()
{
return $this->count;
}
/**
* Identifier of the next element to get the next range of results.
* Set Next ID
* Identifier of the next element to get the next range of results
*
* @param string $next_id
*
* @return $this
*/
public function setNextId($next_id) {
public function setNextId($next_id)
{
$this->next_id = $next_id;
return $this;
}
/**
* Identifier of the next element to get the next range of results.
* Get Next ID
* Identifier of the next element to get the next range of results
*
* @return string
*/
public function getNextId() {
public function getNextId()
{
return $this->next_id;
}
/**
* Identifier of the next element to get the next range of results.
* Set Next ID
* Identifier of the next element to get the next range of results
*
* @param string $next_id
* @deprecated. Instead use setNextId
*
* @deprecated Use setNextId
*
* @return $this
*/
public function setNext_id($next_id) {
public function setNext_id($next_id)
{
$this->next_id = $next_id;
return $this;
}
/**
* Identifier of the next element to get the next range of results.
* Get Next ID
* Identifier of the next element to get the next range of results
*
* @deprecated Use getNextId
*
* @return string
* @deprecated. Instead use getNextId
*/
public function getNext_id() {
public function getNext_id()
{
return $this->next_id;
}
}

97
lib/PayPal/Api/RedirectUrls.php
View File

@@ -1,77 +1,126 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class RedirectUrls extends PPModel {
/**
* Url where the payer would be redirected to after approving the payment.
* @param string $return_url
/**
* Class RedirectUrls
*
* @property string return_url
* @property string cancel_url
*/
public function setReturnUrl($return_url) {
class RedirectUrls extends PPModel
{
/**
* Set Return URL
* Url where the payer would be redirected to after approving the payment
*
* @param string $return_url
*
* @return $this
*/
public function setReturnUrl($return_url)
{
$this->return_url = $return_url;
return $this;
}
/**
* Url where the payer would be redirected to after approving the payment.
* Get Return URL
* Url where the payer would be redirected to after approving the payment
*
* @return string
*/
public function getReturnUrl() {
public function getReturnUrl()
{
return $this->return_url;
}
/**
* Url where the payer would be redirected to after approving the payment.
* Set Return URL
* Url where the payer would be redirected to after approving the payment
*
* @param string $return_url
* @deprecated. Instead use setReturnUrl
*
* @deprecated Use setReturnUrl
*
* @return $this
*/
public function setReturn_url($return_url) {
public function setReturn_url($return_url)
{
$this->return_url = $return_url;
return $this;
}
/**
* Url where the payer would be redirected to after approving the payment.
* Get Return URL
* Url where the payer would be redirected to after approving the payment
*
* @deprecated Use getReturnUrl
*
* @return string
* @deprecated. Instead use getReturnUrl
*/
public function getReturn_url() {
public function getReturn_url()
{
return $this->return_url;
}
/**
* Url where the payer would be redirected to after canceling the payment.
* Set Cancel URL
* Url where the payer would be redirected to after canceling the payment
*
* @param string $cancel_url
*
* @return $this
*/
public function setCancelUrl($cancel_url) {
public function setCancelUrl($cancel_url)
{
$this->cancel_url = $cancel_url;
return $this;
}
/**
* Url where the payer would be redirected to after canceling the payment.
* Get Cancel URL
* Url where the payer would be redirected to after canceling the payment
*
* @return string
*/
public function getCancelUrl() {
public function getCancelUrl()
{
return $this->cancel_url;
}
/**
* Url where the payer would be redirected to after canceling the payment.
* Set Cancel URL
* Url where the payer would be redirected to after canceling the payment
*
* @param string $cancel_url
* @deprecated. Instead use setCancelUrl
*
* @deprecated Use setCancelUrl
*
* @return $this
*/
public function setCancel_url($cancel_url) {
public function setCancel_url($cancel_url)
{
$this->cancel_url = $cancel_url;
return $this;
}
/**
* Url where the payer would be redirected to after canceling the payment.
* Get Cancel URL
* Url where the payer would be redirected to after canceling the payment
*
* @deprecated Use getCancelUrl
*
* @return string
* @deprecated. Instead use getCancelUrl
*/
public function getCancel_url() {
public function getCancel_url()
{
return $this->cancel_url;
}
}

441
lib/PayPal/Api/Refund.php
View File

@@ -1,251 +1,398 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\IResource;
use PayPal\Rest\Call;
use PayPal\Rest\ApiContext;
use PayPal\Api\Refund;
use PayPal\Rest\IResource;
use PayPal\Transport\PPRestCall;
class Refund extends PPModel implements IResource {
/**
* Class Refund
*
* @property string id
* @property string create_time
* @property \PayPal\Api\Amount amount
* @property string state
* @property string sale_id
* @property string capture_id
* @property string parent_payment
* @property \PayPal\Api\Links links
*/
class Refund extends PPModel implements IResource
{
/**
* @var
*/
private static $credential;
/**
* Set Credential
*
* @deprecated. Pass ApiContext to create/get methods instead
* @param $credential
*
* @deprecated Pass ApiContext to create/get methods instead
*/
public static function setCredential($credential) {
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* Identifier of the refund transaction.
* Set ID
* Identifier of the refund transaction
*
* @param string $id
*
* @return $this
*/
public function setId($id) {
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* Identifier of the refund transaction.
* Get ID
* Identifier of the refund transaction
*
* @return string
*/
public function getId() {
public function getId()
{
return $this->id;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
*
* @return $this
*/
public function setCreateTime($create_time) {
public function setCreateTime($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @return string
*/
public function getCreateTime() {
public function getCreateTime()
{
return $this->create_time;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
* @deprecated. Instead use setCreateTime
*
* @deprecated Use setCreateTime
*
* @return $this
*/
public function setCreate_time($create_time) {
public function setCreate_time($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @deprecated Use getCreateTime
*
* @return string
* @deprecated. Instead use getCreateTime
*/
public function getCreate_time() {
public function getCreate_time()
{
return $this->create_time;
}
/**
* Details including both refunded amount (to Payer) and refunded fee (to Payee).If amount is not specified, it's assumed to be full refund.
* @param PayPal\Api\Amount $amount
* Set Amount
* Details including both refunded amount (to Payer) and refunded fee (to Payee)
* If amount is not specified, it's assumed to be full refund
*
* @param \PayPal\Api\Amount $amount
*
* @return $this
*/
public function setAmount($amount) {
public function setAmount($amount)
{
$this->amount = $amount;
return $this;
}
/**
* Details including both refunded amount (to Payer) and refunded fee (to Payee).If amount is not specified, it's assumed to be full refund.
* @return PayPal\Api\Amount
* Get Amount
* Details including both refunded amount (to Payer) and refunded fee (to Payee)
* If amount is not specified, it's assumed to be full refund
*
* @return \PayPal\Api\Amount
*/
public function getAmount() {
public function getAmount()
{
return $this->amount;
}
/**
* State of the refund transaction.
* Set State
* State of the refund transaction
*
* @param string $state
*
* @return $this
*/
public function setState($state) {
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* State of the refund transaction.
* Get State
* State of the refund transaction
*
* @return string
*/
public function getState() {
public function getState()
{
return $this->state;
}
/**
* ID of the Sale transaction being refunded.
* @param string $sale_id
*/
public function setSaleId($sale_id) {
$this->sale_id = $sale_id;
return $this;
}
/**
* ID of the Sale transaction being refunded.
* @return string
*/
public function getSaleId() {
return $this->sale_id;
}
/**
* ID of the Sale transaction being refunded.
* @param string $sale_id
* @deprecated. Instead use setSaleId
*/
public function setSale_id($sale_id) {
$this->sale_id = $sale_id;
return $this;
}
/**
* ID of the Sale transaction being refunded.
* @return string
* @deprecated. Instead use getSaleId
*/
public function getSale_id() {
return $this->sale_id;
}
/**
* ID of the Capture transaction being refunded.
* @param string $capture_id
*/
public function setCaptureId($capture_id) {
$this->capture_id = $capture_id;
return $this;
}
/**
* ID of the Capture transaction being refunded.
* @return string
*/
public function getCaptureId() {
return $this->capture_id;
}
/**
* ID of the Capture transaction being refunded.
* @param string $capture_id
* @deprecated. Instead use setCaptureId
*/
public function setCapture_id($capture_id) {
$this->capture_id = $capture_id;
return $this;
}
/**
* ID of the Capture transaction being refunded.
* @return string
* @deprecated. Instead use getCaptureId
*/
public function getCapture_id() {
return $this->capture_id;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
*/
public function setParentPayment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
*/
public function getParentPayment() {
return $this->parent_payment;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
* @deprecated. Instead use setParentPayment
*/
public function setParent_payment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
* @deprecated. Instead use getParentPayment
*/
public function getParent_payment() {
return $this->parent_payment;
}
/**
* Set Sale ID
* ID of the Sale transaction being refunded
*
* @array
* @param PayPal\Api\Links $links
* @param string $sale_id
*
* @return $this
*/
public function setLinks($links) {
public function setSaleId($sale_id)
{
$this->sale_id = $sale_id;
return $this;
}
/**
* Get Sale ID
* ID of the Sale transaction being refunded
*
* @return string
*/
public function getSaleId()
{
return $this->sale_id;
}
/**
* Set Sale ID
* ID of the Sale transaction being refunded
*
* @param string $sale_id
*
* @deprecated Use setSaleId
*
* @return $this
*/
public function setSale_id($sale_id)
{
$this->sale_id = $sale_id;
return $this;
}
/**
* Get Sale ID
* ID of the Sale transaction being refunded
*
* @deprecated Use getSaleId
*
* @return string
*/
public function getSale_id()
{
return $this->sale_id;
}
/**
* Set Capture ID
* ID of the Capture transaction being refunded
*
* @param string $capture_id
*
* @return $this
*/
public function setCaptureId($capture_id)
{
$this->capture_id = $capture_id;
return $this;
}
/**
* Get Capture ID
* ID of the Capture transaction being refunded
*
* @return string
*/
public function getCaptureId()
{
return $this->capture_id;
}
/**
* Set Capture ID
* ID of the Capture transaction being refunded
*
* @param string $capture_id
*
* @deprecated Use setCaptureId
*
* @return $this
*/
public function setCapture_id($capture_id)
{
$this->capture_id = $capture_id;
return $this;
}
/**
* Get Capture ID
* ID of the Capture transaction being refunded
*
* @deprecated Use getCaptureId
*
* @return string
*/
public function getCapture_id()
{
return $this->capture_id;
}
/**
* Set Parent Payment
* 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
*
* @return string
*/
public function getParentPayment()
{
return $this->parent_payment;
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @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
*
* @return string
*/
public function getParent_payment()
{
return $this->parent_payment;
}
/**
* Set Links
*
* @param \PayPal\Api\Links $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
*
* @return PayPal\Api\Links
* @return \PayPal\Api\Links
*/
public function getLinks() {
public function getLinks()
{
return $this->links;
}
public static function get($refundId, $apiContext = null) {
/**
* Get
*
* @param $refundId
* @param null $apiContext
*
* @return Refund
* @throws \InvalidArgumentException
*/
public static function get($refundId, $apiContext = null)
{
if (($refundId == null) || (strlen($refundId) <= 0)) {
throw new \InvalidArgumentException("refundId cannot be null or empty");
}
$payLoad = "";
if ($apiContext == null) {
$apiContext = new ApiContext(self::$credential);
}
$call = new PPRestCall($apiContext);
$json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/refund/$refundId", "GET", $payLoad);
$ret = new Refund();
$ret->fromJson($json);
return $ret;
}
}

89
lib/PayPal/Api/RelatedResources.php
View File

@@ -1,79 +1,120 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class RelatedResources extends PPModel {
/**
* A sale transaction
* @param PayPal\Api\Sale $sale
/**
* Class RelatedResources
*
* @property \PayPal\Api\Sale sale
* @property \PayPal\Api\Authorization authorization
* @property \PayPal\Api\Capture capture
* @property \PayPal\Api\Refund refund
*/
public function setSale($sale) {
class RelatedResources extends PPModel
{
/**
* Set Sale
* A sale transaction
*
* @param \PayPal\Api\Sale $sale
*
* @return $this
*/
public function setSale($sale)
{
$this->sale = $sale;
return $this;
}
/**
* Get Sale
* A sale transaction
* @return PayPal\Api\Sale
*
* @return \PayPal\Api\Sale
*/
public function getSale() {
public function getSale()
{
return $this->sale;
}
/**
* Set Authorization
* An authorization transaction
* @param PayPal\Api\Authorization $authorization
*
* @param \PayPal\Api\Authorization $authorization
*
* @return $this
*/
public function setAuthorization($authorization) {
public function setAuthorization($authorization)
{
$this->authorization = $authorization;
return $this;
}
/**
* Get Authorization
* An authorization transaction
* @return PayPal\Api\Authorization
*
* @return \PayPal\Api\Authorization
*/
public function getAuthorization() {
public function getAuthorization()
{
return $this->authorization;
}
/**
* Set Capture
* A capture transaction
* @param PayPal\Api\Capture $capture
*
* @param \PayPal\Api\Capture $capture
*
* @return $this
*/
public function setCapture($capture) {
public function setCapture($capture)
{
$this->capture = $capture;
return $this;
}
/**
* Get Capture
* A capture transaction
* @return PayPal\Api\Capture
*
* @return \PayPal\Api\Capture
*/
public function getCapture() {
public function getCapture()
{
return $this->capture;
}
/**
* Set Refund
* A refund transaction
* @param PayPal\Api\Refund $refund
*
* @param \PayPal\Api\Refund $refund
*
* @return $this
*/
public function setRefund($refund) {
public function setRefund($refund)
{
$this->refund = $refund;
return $this;
}
/**
* Get Refund
* A refund transaction
* @return PayPal\Api\Refund
*
* @return \PayPal\Api\Refund
*/
public function getRefund() {
public function getRefund()
{
return $this->refund;
}
}

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

@@ -1,235 +1,373 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\IResource;
use PayPal\Rest\Call;
use PayPal\Rest\ApiContext;
use PayPal\Api\Sale;
use PayPal\Api\Refund;
use PayPal\Rest\IResource;
use PayPal\Transport\PPRestCall;
class Sale extends PPModel implements IResource {
/**
* Class Sale
*
* @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
*/
class Sale extends PPModel implements IResource
{
/**
* @var
*/
private static $credential;
/**
* Set Credential
*
* @deprecated. Pass ApiContext to create/get methods instead
* @param $credential
*
* @deprecated Pass ApiContext to create/get methods instead
*/
public static function setCredential($credential) {
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* Identifier of the authorization transaction.
* Set ID
* Identifier of the authorization transaction
*
* @param string $id
*
* @return $this
*/
public function setId($id) {
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* Identifier of the authorization transaction.
* Get ID
* Identifier of the authorization transaction
*
* @return string
*/
public function getId() {
public function getId()
{
return $this->id;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
*
* @return $this
*/
public function setCreateTime($create_time) {
public function setCreateTime($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @return string
*/
public function getCreateTime() {
public function getCreateTime()
{
return $this->create_time;
}
/**
* Time the resource was created.
* Set Create Time
* Time the resource was created
*
* @param string $create_time
* @deprecated. Instead use setCreateTime
*
* @deprecated Use setCreateTime
*
* @return $this
*/
public function setCreate_time($create_time) {
public function setCreate_time($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
* Get Create Time
* Time the resource was created
*
* @deprecated Use getCreateTime
*
* @return string
* @deprecated. Instead use getCreateTime
*/
public function getCreate_time() {
public function getCreate_time()
{
return $this->create_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
*
* @return $this
*/
public function setUpdateTime($update_time) {
public function setUpdateTime($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @return string
*/
public function getUpdateTime() {
public function getUpdateTime()
{
return $this->update_time;
}
/**
* Time the resource was last updated.
* Set Update Time
* Time the resource was last updated
*
* @param string $update_time
* @deprecated. Instead use setUpdateTime
*
* @deprecated Use setUpdateTime
*
* @return $this
*/
public function setUpdate_time($update_time) {
public function setUpdate_time($update_time)
{
$this->update_time = $update_time;
return $this;
}
/**
* Time the resource was last updated.
* Get Update Time
* Time the resource was last updated
*
* @deprecated Use getUpdateTime
*
* @return string
* @deprecated. Instead use getUpdateTime
*/
public function getUpdate_time() {
public function getUpdate_time()
{
return $this->update_time;
}
/**
* Amount being collected.
* @param PayPal\Api\Amount $amount
* Set Amount
* Amount being collected
*
* @param \PayPal\Api\Amount $amount
*
* @return $this
*/
public function setAmount($amount) {
public function setAmount($amount)
{
$this->amount = $amount;
return $this;
}
/**
* Amount being collected.
* @return PayPal\Api\Amount
* Get Amount
* Amount being collected
*
* @return \PayPal\Api\Amount
*/
public function getAmount() {
public function getAmount()
{
return $this->amount;
}
/**
* State of the sale transaction.
* Set State
* State of the sale transaction
*
* @param string $state
*
* @return $this
*/
public function setState($state) {
public function setState($state)
{
$this->state = $state;
return $this;
}
/**
* State of the sale transaction.
* Get State
* State of the sale transaction
*
* @return string
*/
public function getState() {
public function getState()
{
return $this->state;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
*/
public function setParentPayment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
*/
public function getParentPayment() {
return $this->parent_payment;
}
/**
* ID of the Payment resource that this transaction is based on.
* @param string $parent_payment
* @deprecated. Instead use setParentPayment
*/
public function setParent_payment($parent_payment) {
$this->parent_payment = $parent_payment;
return $this;
}
/**
* ID of the Payment resource that this transaction is based on.
* @return string
* @deprecated. Instead use getParentPayment
*/
public function getParent_payment() {
return $this->parent_payment;
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @array
* @param PayPal\Api\Links $links
* @param string $parent_payment
*
* @return $this
*/
public function setLinks($links) {
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
*
* @return string
*/
public function getParentPayment()
{
return $this->parent_payment;
}
/**
* Set Parent Payment
* ID of the Payment resource that this transaction is based on
*
* @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
*
* @return string
*/
public function getParent_payment()
{
return $this->parent_payment;
}
/**
* Set Links
*
* @param \PayPal\Api\Links $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Get Links
*
* @return PayPal\Api\Links
* @return \PayPal\Api\Links
*/
public function getLinks() {
public function getLinks()
{
return $this->links;
}
public static function get($saleId, $apiContext = null) {
/**
* Get
*
* @param int $saleId
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @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");
}
$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;
}
public function refund($refund, $apiContext = null) {
/**
* Refund
*
* @param \Paypal\Api\Refund $refund
* @param \PayPal\Rest\ApiContext|null $apiContext
*
* @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");
}
$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;
}
}

55
lib/PayPal/Api/ShippingAddress.php
View File

@@ -1,42 +1,69 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class ShippingAddress extends Address {
/**
* Name of the recipient at this address.
* @param string $recipient_name
/**
* Class ShippingAddress
*
* @property string recipient_name
*/
public function setRecipientName($recipient_name) {
class ShippingAddress extends Address
{
/**
* Set Recipient Name
* Name of the recipient at this address
*
* @param string $recipient_name
*
* @return $this
*/
public function setRecipientName($recipient_name)
{
$this->recipient_name = $recipient_name;
return $this;
}
/**
* Name of the recipient at this address.
* Get Recipient Name
* Name of the recipient at this address
*
* @return string
*/
public function getRecipientName() {
public function getRecipientName()
{
return $this->recipient_name;
}
/**
* Name of the recipient at this address.
* Set Recipient Name
* Name of the recipient at this address
*
* @param string $recipient_name
* @deprecated. Instead use setRecipientName
*
* @deprecated Use setRecipientName
*
* @return $this
*/
public function setRecipient_name($recipient_name) {
public function setRecipient_name($recipient_name)
{
$this->recipient_name = $recipient_name;
return $this;
}
/**
* Name of the recipient at this address.
* Get Recipient Name
* Name of the recipient at this address
*
* @deprecated Use getRecipientName
*
* @return string
* @deprecated. Instead use getRecipientName
*/
public function getRecipient_name() {
public function getRecipient_name()
{
return $this->recipient_name;
}
}

202
lib/PayPal/Api/Transaction.php
View File

@@ -1,152 +1,234 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Transaction extends PPModel {
/**
* Amount being collected.
* @param PayPal\Api\Amount $amount
/**
* Class Transaction
*
* @property \PayPal\Api\Amount amount
* @property \PayPal\Api\Payee payee
* @property string description
* @property \PayPal\Api\ItemList item_list
* @property \PayPal\Api\RelatedResources related_resources
* @property \PayPal\Api\Transaction transactions
*/
public function setAmount($amount) {
class Transaction extends PPModel
{
/**
* Set Amount
* Amount being collected
*
* @param \PayPal\Api\Amount $amount
*
* @return $this
*/
public function setAmount($amount)
{
$this->amount = $amount;
return $this;
}
/**
* Amount being collected.
* @return PayPal\Api\Amount
* Get Amount
* Amount being collected
*
* @return \PayPal\Api\Amount
*/
public function getAmount() {
public function getAmount()
{
return $this->amount;
}
/**
* Recepient of the funds in this transaction.
* @param PayPal\Api\Payee $payee
* Set Payee
* Recepient of the funds in this transaction
*
* @param \PayPal\Api\Payee $payee
*
* @return $this
*/
public function setPayee($payee) {
public function setPayee($payee)
{
$this->payee = $payee;
return $this;
}
/**
* Recepient of the funds in this transaction.
* @return PayPal\Api\Payee
* Get Payee
* Recepient of the funds in this transaction
*
* @return \PayPal\Api\Payee
*/
public function getPayee() {
public function getPayee()
{
return $this->payee;
}
/**
* Description of what is being paid for.
* Set Description
* Description of what is being paid for
*
* @param string $description
*
* @return $this
*/
public function setDescription($description) {
public function setDescription($description)
{
$this->description = $description;
return $this;
}
/**
* Description of what is being paid for.
* Get Description
* Description of what is being paid for
*
* @return string
*/
public function getDescription() {
public function getDescription()
{
return $this->description;
}
/**
* List of items being paid for.
* @param PayPal\Api\ItemList $item_list
* Set Item List
* List of items being paid for
*
* @param \PayPal\Api\ItemList $item_list
*
* @return $this
*/
public function setItemList($item_list) {
public function setItemList($item_list)
{
$this->item_list = $item_list;
return $this;
}
/**
* List of items being paid for.
* @return PayPal\Api\ItemList
* Get Item List
* List of items being paid for
*
* @return \PayPal\Api\ItemList
*/
public function getItemList() {
public function getItemList()
{
return $this->item_list;
}
/**
* List of items being paid for.
* @param PayPal\Api\ItemList $item_list
* @deprecated. Instead use setItemList
* Set Item List
* List of items being paid for
*
* @param \PayPal\Api\ItemList $item_list
*
* @deprecated Use setItemList
*
* @return $this
*/
public function setItem_list($item_list) {
public function setItem_list($item_list)
{
$this->item_list = $item_list;
return $this;
}
/**
* List of items being paid for.
* @return PayPal\Api\ItemList
* @deprecated. Instead use getItemList
* Get Item List
* List of items being paid for
*
* @deprecated Use getItemList
*
* @return \PayPal\Api\ItemList
*/
public function getItem_list() {
public function getItem_list()
{
return $this->item_list;
}
/**
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment.
* @array
* @param PayPal\Api\RelatedResources $related_resources
* Set Related Resources
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment
*
* @param \PayPal\Api\RelatedResources $related_resources
*
* @return $this
*/
public function setRelatedResources($related_resources) {
public function setRelatedResources($related_resources)
{
$this->related_resources = $related_resources;
return $this;
}
/**
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment.
* @return PayPal\Api\RelatedResources
* Get Related Resources
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment
*
* @return \PayPal\Api\RelatedResources
*/
public function getRelatedResources() {
public function getRelatedResources()
{
return $this->related_resources;
}
/**
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment.
* @array
* @param PayPal\Api\RelatedResources $related_resources
* @deprecated. Instead use setRelatedResources
* Set Related Resources
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment
*
* @param \PayPal\Api\RelatedResources $related_resources
*
* @deprecated Use setRelatedResources
*
* @return $this
*/
public function setRelated_resources($related_resources) {
public function setRelated_resources($related_resources)
{
$this->related_resources = $related_resources;
return $this;
}
/**
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment.
* @return PayPal\Api\RelatedResources
* @deprecated. Instead use getRelatedResources
* Get Related Resources
* List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment
*
* @deprecated Use getRelatedResources
*
* @return \PayPal\Api\RelatedResources
*/
public function getRelated_resources() {
public function getRelated_resources()
{
return $this->related_resources;
}
/**
* Additional transactions for complex payment (Parallel and Chained) scenarios.
* @array
* @param PayPal\Api\self $transactions
* Set Transactions
* Additional transactions for complex payment (Parallel and Chained) scenarios
*
* @param \PayPal\Api\self $transactions
*
* @return $this
*/
public function setTransactions($transactions) {
public function setTransactions($transactions)
{
$this->transactions = $transactions;
return $this;
}
/**
* Additional transactions for complex payment (Parallel and Chained) scenarios.
* @return PayPal\Api\self
* Set Transactions
* Additional transactions for complex payment (Parallel and Chained) scenarios
*
* @return \PayPal\Api\self
*/
public function getTransactions() {
public function getTransactions()
{
return $this->transactions;
}
}

32
lib/PayPal/Api/Transactions.php
View File

@@ -1,25 +1,37 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
class Transactions extends PPModel {
/**
* Amount being collected.
* @param PayPal\Api\Amount $amount
/**
* Class Transactions
*
* @property \PayPal\Api\Amount amount
*/
public function setAmount($amount) {
class Transactions extends PPModel
{
/**
* Set Amount
*
* @param \PayPal\Api\Amount $amount
*
* @return $this
*/
public function setAmount($amount)
{
$this->amount = $amount;
return $this;
}
/**
* Amount being collected.
* @return PayPal\Api\Amount
* Get Amount
*
* @return \PayPal\Api\Amount
*/
public function getAmount() {
public function getAmount()
{
return $this->amount;
}
}

91
lib/PayPal/Auth/OAuthTokenCredential.php
View File

@@ -1,117 +1,159 @@
<?php
/**
* Oauth Token credential
*/
namespace PayPal\Auth;
/**
* Oauth Token credential
*
*/
use PayPal\Rest\RestHandler;
use PayPal\Common\PPUserAgent;
use PayPal\Core\PPLoggingManager;
use PayPal\Core\PPConnectionManager;
use PayPal\Core\PPConstants;
use PayPal\Core\PPHttpConfig;
use PayPal\Core\PPConnectionManager;
use PayPal\Core\PPLoggingManager;
use PayPal\Exception\PPConfigurationException;
use PayPal\Rest\RestHandler;
class OAuthTokenCredential {
/**
* Class OAuthTokenCredential
*/
class OAuthTokenCredential
{
/**
* Private Variable
*
* @var int $expiryBufferTime
*/
private static $expiryBufferTime = 120;
/**
* Private Variable
*
* @var \PayPal\Core\PPLoggingManager $logger
*/
private $logger;
/**
* Client ID as obtained from the developer portal
*
* @var string $clientId
*/
private $clientId;
/**
* Client secret as obtained from the developer portal
*
* @var string $clientSecret
*/
private $clientSecret;
/**
* Generated Access Token
*
* @var $accessToken
*/
private $accessToken;
/**
* Seconds for with access token is valid
*
* @var $tokenExpiresIn
*/
private $tokenExpiresIn;
/**
* Last time (in milliseconds) when access token was generated
*
* @var $tokenCreateTime
*/
private $tokenCreateTime;
/**
* Construct
*
* @param string $clientId client id obtained from the developer portal
* @param string $clientSecret client secret obtained from the developer portal
*/
public function __construct($clientId, $clientSecret) {
public function __construct($clientId, $clientSecret)
{
$this->clientId = $clientId;
$this->clientSecret = $clientSecret;
}
/**
* @return the accessToken
* Get AccessToken
*
* @param $config
*
* @return null|string
*/
public function getAccessToken($config) {
public function getAccessToken($config)
{
$this->logger = new PPLoggingManager(__CLASS__, $config);
// Check if Access Token is not null and has not expired.
// The API returns expiry time as a relative time unit
// We use a buffer time when checking for token expiry to account
// for API call delays and any delay between the time the token is
// retrieved and subsequently used
if ($this->accessToken != null &&
(time() - $this->tokenCreateTime) > ($this->tokenExpiresIn - self::$expiryBufferTime)) {
if ($this->accessToken != null && (time() - $this->tokenCreateTime) > ($this->tokenExpiresIn - self::$expiryBufferTime)) {
$this->accessToken = null;
}
// If accessToken is Null, obtain a new token
if ($this->accessToken == null) {
$this->_generateAccessToken($config);
}
return $this->accessToken;
}
/**
* Generates a new access token
*
* @param $config
*
* @return null
*/
private function _generateAccessToken($config) {
private function _generateAccessToken($config)
{
$base64ClientID = base64_encode($this->clientId . ":" . $this->clientSecret);
$headers = array(
"User-Agent" => PPUserAgent::getValue(RestHandler::$sdkName, RestHandler::$sdkVersion),
"Authorization" => "Basic " . $base64ClientID,
"Accept" => "*/*"
);
$httpConfiguration = $this->getOAuthHttpConfiguration($config);
$httpConfiguration->setHeaders($headers);
$connection = PPConnectionManager::getInstance()->getConnection($httpConfiguration, $config);
$res = $connection->execute("grant_type=client_credentials");
$jsonResponse = json_decode($res, true);
if($jsonResponse == NULL ||
!isset($jsonResponse["access_token"]) || !isset($jsonResponse["expires_in"]) ) {
$this->accessToken = NULL;
$this->tokenExpiresIn = NULL;
if ($jsonResponse == null || !isset($jsonResponse["access_token"]) || !isset($jsonResponse["expires_in"])) {
$this->accessToken = null;
$this->tokenExpiresIn = null;
$this->logger->warning("Could not generate new Access token. Invalid response from server: " . $jsonResponse);
} else {
$this->accessToken = $jsonResponse["access_token"];
$this->tokenExpiresIn = $jsonResponse["expires_in"];
}
$this->tokenCreateTime = time();
return $this->accessToken;
}
/*
/**
* Get HttpConfiguration object for OAuth API
*
* @param array $config
*
* @return PPHttpConfig
* @throws \PayPal\Exception\PPConfigurationException
*/
private function getOAuthHttpConfiguration($config) {
private function getOAuthHttpConfiguration($config)
{
if (isset($config['oauth.EndPoint'])) {
$baseEndpoint = $config['oauth.EndPoint'];
} else if (isset($config['service.EndPoint'])) {
@@ -132,6 +174,7 @@ class OAuthTokenCredential {
}
$baseEndpoint = rtrim(trim($baseEndpoint), '/');
return new PPHttpConfig($baseEndpoint . "/v1/oauth2/token", "POST");
}
}

54
lib/PayPal/Rest/ApiContext.php
View File

@@ -1,17 +1,21 @@
<?php
/**
* Call level parameters such as request id, credentials etc
*/
namespace PayPal\Rest;
use PayPal\Common\PPApiContext;
/**
*
* Call level parameters such as
* request id, credentials etc
*/
class ApiContext extends PPApiContext {
/**
* Class ApiContext
*/
class ApiContext extends PPApiContext
{
/**
* OAuth Credentials to use for this call
* @var PayPal/Api/OAuthTokenCredential
*
* @var \PayPal\Auth\OAuthTokenCredential $credential
*/
private $credential;
@@ -19,31 +23,43 @@ class ApiContext extends PPApiContext {
* Unique request id to be used for this call
* The user can either generate one as per application
* needs or let the SDK generate one
* @var string
*
* @var null|string $requestId
*/
private $requestId;
/**
* Get Credential
*
* @return \PayPal\Auth\OAuthTokenCredential
*/
public function getCredential() {
public function getCredential()
{
return $this->credential;
}
public function getrequestId() {
if($this->requestId == null) {
/**
* Get Request ID
*
* @return string
*/
public function getrequestId()
{
if ($this->requestId == null) {
$this->requestId = $this->generateRequestId();
}
return $this->requestId;
}
/**
* Construct
*
* @param PayPal/Api/OAuthTokenCredential $credential
* @param string $requestId
* @param \PayPal\Auth\OAuthTokenCredential $credential
* @param string|null $requestId
*/
public function __construct($credential, $requestId=null) {
public function __construct($credential, $requestId = null)
{
$this->credential = $credential;
$this->requestId = $requestId;
}
@@ -52,18 +68,20 @@ class ApiContext extends PPApiContext {
* Generates a unique per request id that
* can be used to set the PayPal-Request-Id header
* that is used for idemptency
*
* @return string
*/
private function generateRequestId() {
private function generateRequestId()
{
static $pid = -1;
static $addr = -1;
if ($pid == -1) {
$pid = getmypid();
}
if ($addr == -1) {
if(array_key_exists('SERVER_ADDR', $_SERVER)) {
if (array_key_exists('SERVER_ADDR', $_SERVER)) {
$addr = ip2long($_SERVER['SERVER_ADDR']);
} else {
$addr = php_uname('n');

7
lib/PayPal/Rest/IResource.php
View File

@@ -2,6 +2,9 @@
namespace PayPal\Rest;
interface IResource {
/**
* Interface IResource
*/
interface IResource
{
}

93
lib/PayPal/Rest/RestHandler.php
View File

@@ -1,67 +1,115 @@
<?php
/**
* API handler for all REST API calls
*/
namespace PayPal\Rest;
use PayPal\Auth\OAuthTokenCredential;
use PayPal\Handler\IPPHandler;
use PayPal\Core\PPCredentialManager;
use PayPal\Core\PPConstants;
use PayPal\Exception\PPMissingCredentialException;
use PayPal\Exception\PPInvalidCredentialException;
use PayPal\Exception\PPConfigurationException;
use PayPal\Common\PPUserAgent;
use PayPal\Core\PPConstants;
use PayPal\Core\PPCredentialManager;
use PayPal\Exception\PPConfigurationException;
use PayPal\Exception\PPInvalidCredentialException;
use PayPal\Exception\PPMissingCredentialException;
use PayPal\Handler\IPPHandler;
/**
*
* API handler for all REST API calls
* Class RestHandler
*/
class RestHandler implements IPPHandler
{
/**
* Private Variable
*
* @var \Paypal\Rest\ApiContext $apiContext
*/
class RestHandler implements IPPHandler {
private $apiContext;
/**
* Public Variable
*
* @var string $sdkName
*/
public static $sdkName = "rest-sdk-php";
/**
* Public Variable
*
* @var string $sdkVersion
*/
public static $sdkVersion = "0.6.0";
public function __construct($apiContext) {
/**
* Construct
*
* @param \Paypal\Rest\ApiContext $apiContext
*/
public function __construct($apiContext)
{
$this->apiContext = $apiContext;
}
public function handle($httpConfig, $request, $options) {
/**
* Handle
*
* @param \PayPal\Core\PPHttpConfig $httpConfig
* @param \PayPal\Core\PPRequest $request
* @param array $options
*
* @throws \PayPal\Exception\PPInvalidCredentialException
* @throws \PayPal\Exception\PPMissingCredentialException
*/
public function handle($httpConfig, $request, $options)
{
$credential = $this->apiContext->getCredential();
$config = $this->apiContext->getConfig();
if($credential == NULL) {
if ($credential == null) {
// Try picking credentials from the config file
$credMgr = PPCredentialManager::getInstance($config);
$credValues = $credMgr->getCredentialObject();
if(!is_array($credValues)) {
if (!is_array($credValues)) {
throw new PPMissingCredentialException("Empty or invalid credentials passed");
}
$credential = new OAuthTokenCredential($credValues['clientId'], $credValues['clientSecret']);
}
if($credential == NULL || ! ($credential instanceof OAuthTokenCredential) ) {
if ($credential == null || !($credential instanceof OAuthTokenCredential)) {
throw new PPInvalidCredentialException("Invalid credentials passed");
}
$httpConfig->setUrl(
rtrim( trim($this->_getEndpoint($config)), '/') .
rtrim(trim($this->_getEndpoint($config)), '/') .
(isset($options['path']) ? $options['path'] : '')
);
if(!array_key_exists("User-Agent", $httpConfig->getHeaders())) {
if (!array_key_exists("User-Agent", $httpConfig->getHeaders())) {
$httpConfig->addHeader("User-Agent", PPUserAgent::getValue(self::$sdkName, self::$sdkVersion));
}
if(!is_null($credential) && $credential instanceof OAuthTokenCredential) {
if (!is_null($credential) && $credential instanceof OAuthTokenCredential) {
$httpConfig->addHeader('Authorization', "Bearer " . $credential->getAccessToken($config));
}
if($httpConfig->getMethod() == 'POST' || $httpConfig->getMethod() == 'PUT') {
if ($httpConfig->getMethod() == 'POST' || $httpConfig->getMethod() == 'PUT') {
$httpConfig->addHeader('PayPal-Request-Id', $this->apiContext->getRequestId());
}
}
private function _getEndpoint($config) {
/**
* End Point
*
* @param array $config
*
* @return string
* @throws \PayPal\Exception\PPConfigurationException
*/
private function _getEndpoint($config)
{
if (isset($config['service.EndPoint'])) {
return $config['service.EndPoint'];
} else if (isset($config['mode'])) {
@@ -80,5 +128,4 @@ class RestHandler implements IPPHandler {
throw new PPConfigurationException('You must set one of service.endpoint or mode parameters in your configuration');
}
}
}