diff --git a/lib/PayPal/Api/Address.php b/lib/PayPal/Api/Address.php index a5191c9..1b0744d 100644 --- a/lib/PayPal/Api/Address.php +++ b/lib/PayPal/Api/Address.php @@ -1,186 +1,263 @@ line1 = $line1; - return $this; - } +/** + * 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 + */ +class Address extends PPModel +{ + /** + * Set Line 1 + * Address (eg. number, street, etc) + * + * @param string $line1 + * + * @return $this + */ + public function setLine1($line1) + { + $this->line1 = $line1; - /** - * Line 1 of the Address (eg. number, street, etc). - * - * @return string - */ - public function getLine1() { - return $this->line1; - } + return $this; + } + /** + * Get Line 1 + * Address (eg. number, street, etc) + * + * @return string + */ + public function getLine1() + { + return $this->line1; + } - /** - * Optional line 2 of the Address (eg. suite, apt #, etc.). - * - * @param string $line2 - */ - public function setLine2($line2) { - $this->line2 = $line2; - return $this; - } + /** + * Set Line 2 (Optional) + * Address (eg. suite, apt #, etc) + * + * @param string $line2 + * + * @return $this + */ + public function setLine2($line2) + { + $this->line2 = $line2; - /** - * Optional line 2 of the Address (eg. suite, apt #, etc.). - * - * @return string - */ - public function getLine2() { - return $this->line2; - } + return $this; + } + /** + * Get Line 2 (Optional) + * Address (eg. suite, apt #, etc) + * + * @return string + */ + public function getLine2() + { + return $this->line2; + } - /** - * City name. - * - * @param string $city - */ - public function setCity($city) { - $this->city = $city; - return $this; - } + /** + * Set City Name + * + * @param string $city + * + * @return $this + */ + public function setCity($city) + { + $this->city = $city; - /** - * City name. - * - * @return string - */ - public function getCity() { - return $this->city; - } + return $this; + } + /** + * Get City Name + * + * @return string + */ + public function getCity() + { + return $this->city; + } - /** - * 2 letter country code. - * - * @param string $country_code - */ - public function setCountryCode($country_code) { - $this->country_code = $country_code; - return $this; - } + /** + * Set Country Code + * Two Letter + * + * @param string $country_code + * + * @return $this + */ + public function setCountryCode($country_code) + { + $this->country_code = $country_code; - /** - * 2 letter country code. - * - * @return string - */ - public function getCountryCode() { - return $this->country_code; - } + return $this; + } - /** - * 2 letter country code. - * - * @param string $country_code - * @deprecated. Instead use setCountryCode - */ - public function setCountry_code($country_code) { - $this->country_code = $country_code; - return $this; - } - /** - * 2 letter country code. - * - * @return string - * @deprecated. Instead use getCountryCode - */ - public function getCountry_code() { - return $this->country_code; - } + /** + * Get Country Code + * Two Letter + * + * @return string + */ + public function getCountryCode() + { + 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. - * - * @param string $postal_code - */ - public function setPostalCode($postal_code) { - $this->postal_code = $postal_code; - return $this; - } + /** + * Set Country Code + * Two Letter + * + * @param string $country_code + * + * @deprecated Use setCountryCode + * + * @return $this + */ + public function setCountry_code($country_code) + { + $this->country_code = $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. - * - * @return string - */ - public function getPostalCode() { - return $this->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. - * - * @param string $postal_code - * @deprecated. Instead use setPostalCode - */ - 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. - * - * @return string - * @deprecated. Instead use getPostalCode - */ - public function getPostal_code() { - return $this->postal_code; - } + /** + * Get Country Code + * Two Letter + * + * @deprecated Use getCountryCode + * + * @return string + */ + public function getCountry_code() + { + return $this->country_code; + } - /** - * 2 letter code for US states, and the equivalent for other countries. - * - * @param string $state - */ - public function setState($state) { - $this->state = $state; - return $this; - } + /** + * 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) + { + $this->postal_code = $postal_code; - /** - * 2 letter code for US states, and the equivalent for other countries. - * - * @return string - */ - public function getState() { - return $this->state; - } + return $this; + } + /** + * 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() + { + return $this->postal_code; + } - /** - * Phone number in E.123 format. - * - * @param string $phone - */ - public function setPhone($phone) { - $this->phone = $phone; - return $this; - } + /** + * 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 Use setPostalCode + * + * @return $this + */ + public function setPostal_code($postal_code) + { + $this->postal_code = $postal_code; - /** - * Phone number in E.123 format. - * - * @return string - */ - public function getPhone() { - return $this->phone; - } + return $this; + } + /** + * 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 + */ + public function getPostal_code() + { + return $this->postal_code; + } + /** + * Set State + * Two Letter Code for US States and the equivalent for other countries + * + * @param string $state + * + * @return $this + */ + public function setState($state) + { + $this->state = $state; + + return $this; + } + + /** + * Get State + * Two Letter Code for US States and the equivalent for other countries + * + * @return string + */ + public function getState() + { + return $this->state; + } + + /** + * Set Phone Number + * E.123 format + * + * @param string $phone + * + * @return $this + */ + public function setPhone($phone) + { + $this->phone = $phone; + return $this; + } + + /** + * Get Phone Number + * E.123 format + * + * @return string + */ + public function getPhone() + { + return $this->phone; + } } diff --git a/lib/PayPal/Api/Amount.php b/lib/PayPal/Api/Amount.php index d03ed2e..e092149 100644 --- a/lib/PayPal/Api/Amount.php +++ b/lib/PayPal/Api/Amount.php @@ -1,68 +1,95 @@ currency = $currency; - return $this; - } +/** + * Class Amount + * + * @property string currency + * @property string total + * @property \PayPal\Api\Details details + */ +class Amount extends PPModel +{ + /** + * Set Currency + * Three Letter Currency Code + * + * @param string $currency + * + * @return $this + */ + public function setCurrency($currency) + { + $this->currency = $currency; - /** - * 3 letter currency code - * - * @return string - */ - public function getCurrency() { - return $this->currency; - } + return $this; + } + /** + * Get Currency + * Three Letter Currency Code + * + * @return string + */ + 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. - * - * @param string $total - */ - public function setTotal($total) { - $this->total = $total; - return $this; - } + /** + * 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) + { + $this->total = $total; - /** - * 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() { - return $this->total; - } + return $this; + } + /** + * 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() + { + return $this->total; + } - /** - * Additional details of the payment amount. - * - * @param PayPal\Api\Details $details - */ - public function setDetails($details) { - $this->details = $details; - return $this; - } - - /** - * Additional details of the payment amount. - * - * @return PayPal\Api\Details - */ - public function getDetails() { - return $this->details; - } - + /** + * Set Details + * Additional Details of Payment Amount + * + * @param \PayPal\Api\Details $details + * + * @return $this + */ + public function setDetails($details) + { + $this->details = $details; + return $this; + } + /** + * Get Details + * Additional Details of Payment Amount + * + * @return \PayPal\Api\Details + */ + public function getDetails() + { + return $this->details; + } } diff --git a/lib/PayPal/Api/Authorization.php b/lib/PayPal/Api/Authorization.php index 0e5a648..7790845 100644 --- a/lib/PayPal/Api/Authorization.php +++ b/lib/PayPal/Api/Authorization.php @@ -1,4 +1,5 @@ id = $id; - /** - * Identifier of the authorization transaction. - * - * @param string $id - */ - public function setId($id) { - $this->id = $id; - return $this; - } + return $this; + } - /** - * Identifier of the authorization transaction. - * - * @return string - */ - public function getId() { - return $this->id; - } + /** + * Get ID + * Identifier of the authorization transaction + * + * @return string + */ + public function getId() + { + return $this->id; + } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @return $this + */ + public function setCreateTime($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was created. - * - * @param string $create_time - */ - public function setCreateTime($create_time) { - $this->create_time = $create_time; - return $this; - } + return $this; + } - /** - * Time the resource was created. - * - * @return string - */ - public function getCreateTime() { - return $this->create_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @return string + */ + public function getCreateTime() + { + return $this->create_time; + } - /** - * Time the resource was created. - * - * @param string $create_time - * @deprecated. Instead use setCreateTime - */ - public function setCreate_time($create_time) { - $this->create_time = $create_time; - return $this; - } - /** - * Time the resource was created. - * - * @return string - * @deprecated. Instead use getCreateTime - */ - public function getCreate_time() { - return $this->create_time; - } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @deprecated Use setCreateTime + * + * @return $this + */ + public function setCreate_time($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was last updated. - * - * @param string $update_time - */ - public function setUpdateTime($update_time) { - $this->update_time = $update_time; - return $this; - } + return $this; + } - /** - * Time the resource was last updated. - * - * @return string - */ - public function getUpdateTime() { - return $this->update_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @deprecated Use getCreateTime + * + * @return string + */ + public function getCreate_time() + { + return $this->create_time; + } - /** - * Time the resource was last updated. - * - * @param string $update_time - * @deprecated. Instead use setUpdateTime - */ - public function setUpdate_time($update_time) { - $this->update_time = $update_time; - return $this; - } - /** - * Time the resource was last updated. - * - * @return string - * @deprecated. Instead use getUpdateTime - */ - public function getUpdate_time() { - return $this->update_time; - } + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @return $this + */ + public function setUpdateTime($update_time) + { + $this->update_time = $update_time; - /** - * Amount being authorized for. - * - * @param PayPal\Api\Amount $amount - */ - public function setAmount($amount) { - $this->amount = $amount; - return $this; - } + return $this; + } - /** - * Amount being authorized for. - * - * @return PayPal\Api\Amount - */ - public function getAmount() { - return $this->amount; - } + /** + * Get Update Time + * Time the resource was last updated + * + * @return string + */ + public function getUpdateTime() + { + return $this->update_time; + } + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @deprecated Use setUpdateTime + * + * @return $this + */ + public function setUpdate_time($update_time) + { + $this->update_time = $update_time; - /** - * State of the authorization transaction. - * - * @param string $state - */ - public function setState($state) { - $this->state = $state; - return $this; - } + return $this; + } - /** - * State of the authorization transaction. - * - * @return string - */ - public function getState() { - return $this->state; - } + /** + * Get Update Time + * Time the resource was last updated + * + * @deprecated Use getUpdateTime + * + * @return string + */ + public function getUpdate_time() + { + return $this->update_time; + } + /** + * Set Amount + * + * @param \PayPal\Api\Amount $amount + * + * @return $this + */ + public function setAmount($amount) + { + $this->amount = $amount; - /** - * 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; - } + return $this; + } - /** - * ID of the Payment resource that this transaction is based on. - * - * @return string - */ - public function getParentPayment() { - return $this->parent_payment; - } + /** + * Get Amount + * + * @return \PayPal\Api\Amount + */ + public function getAmount() + { + return $this->amount; + } - /** - * 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 State + * State of the authorization transaction + * + * @param string $state + * + * @return $this + */ + public function setState($state) + { + $this->state = $state; - /** - * 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; - } + return $this; + } - /** - * Date/Time until which funds may be captured against this resource. - * - * @return string - */ - public function getValidUntil() { - return $this->valid_until; - } + /** + * Get State + * State of the authorization transaction + * + * @return string + */ + public function getState() + { + return $this->state; + } - /** - * 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 + * + * @param string $parent_payment + * + * @return $this + */ + public function setParentPayment($parent_payment) + { + $this->parent_payment = $parent_payment; - /** - * - * - * @array - * @param PayPal\Api\Links $links - */ - public function setLinks($links) { - $this->links = $links; - return $this; - } + return $this; + } - /** - * - * - * @return PayPal\Api\Links - */ - public function getLinks() { - return $this->links; - } + /** + * 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; + } - /* - * Obtain the Authorization transaction resource for the given identifier. - * - * @param string $authorizationId - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Authorization - */ - 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; - } + /** + * 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; + } - /* - * Creates (and processes) a new Capture Transaction added as a related resource. - * - * @param Capture $capture - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Capture - */ - 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; - } + /** + * 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; - /* - * Voids (cancels) an Authorization. - * - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Authorization - */ - 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; - } + return $this; + } - /* - * Reauthorizes an expired Authorization. - * - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Authorization - */ - 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; - } + /** + * 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 + */ + public function getLinks() + { + return $this->links; + } + + /** + * 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; + } + + /** + * 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; + } + + /** + * 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; + } + + /** + * 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; + } } diff --git a/lib/PayPal/Api/Capture.php b/lib/PayPal/Api/Capture.php index 06e91a4..839871c 100644 --- a/lib/PayPal/Api/Capture.php +++ b/lib/PayPal/Api/Capture.php @@ -1,4 +1,5 @@ id = $id; - /** - * Identifier of the Capture transaction. - * - * @param string $id - */ - public function setId($id) { - $this->id = $id; - return $this; - } + return $this; + } - /** - * Identifier of the Capture transaction. - * - * @return string - */ - public function getId() { - return $this->id; - } + /** + * Get ID + * Identifier of the Capture transaction + * + * @return string + */ + public function getId() + { + return $this->id; + } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @return $this + */ + public function setCreateTime($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was created. - * - * @param string $create_time - */ - public function setCreateTime($create_time) { - $this->create_time = $create_time; - return $this; - } + return $this; + } - /** - * Time the resource was created. - * - * @return string - */ - public function getCreateTime() { - return $this->create_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @return string + */ + public function getCreateTime() + { + return $this->create_time; + } - /** - * Time the resource was created. - * - * @param string $create_time - * @deprecated. Instead use setCreateTime - */ - public function setCreate_time($create_time) { - $this->create_time = $create_time; - return $this; - } - /** - * Time the resource was created. - * - * @return string - * @deprecated. Instead use getCreateTime - */ - public function getCreate_time() { - return $this->create_time; - } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @deprecated Use setCreateTime + * + * @return $this + */ + public function setCreate_time($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was last updated. - * - * @param string $update_time - */ - public function setUpdateTime($update_time) { - $this->update_time = $update_time; - return $this; - } + return $this; + } - /** - * Time the resource was last updated. - * - * @return string - */ - public function getUpdateTime() { - return $this->update_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @deprecated Use getCreateTime + * + * @return string + */ + public function getCreate_time() + { + return $this->create_time; + } - /** - * Time the resource was last updated. - * - * @param string $update_time - * @deprecated. Instead use setUpdateTime - */ - public function setUpdate_time($update_time) { - $this->update_time = $update_time; - return $this; - } - /** - * Time the resource was last updated. - * - * @return string - * @deprecated. Instead use getUpdateTime - */ - public function getUpdate_time() { - return $this->update_time; - } + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @return $this + */ + public function setUpdateTime($update_time) + { + $this->update_time = $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 - */ - public function setAmount($amount) { - $this->amount = $amount; - return $this; - } + 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 - */ - public function getAmount() { - return $this->amount; - } + /** + * Get Update Time + * Time the resource was last updated + * + * @return string + */ + public function getUpdateTime() + { + return $this->update_time; + } + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @deprecated Use setUpdateTime + * + * @return $this + */ + public function setUpdate_time($update_time) + { + $this->update_time = $update_time; - /** - * 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 - */ - public function setIsFinalCapture($is_final_capture) { - $this->is_final_capture = $is_final_capture; - return $this; - } + 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. - * - * @return boolean - */ - public function getIsFinalCapture() { - return $this->is_final_capture; - } + /** + * Get Update Time + * Time the resource was last updated + * + * @deprecated Use getUpdateTime + * + * @return string + */ + public function getUpdate_time() + { + return $this->update_time; + } - /** - * 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 - */ - 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. - * - * @return boolean - * @deprecated. Instead use getIsFinalCapture - */ - public function getIs_final_capture() { - return $this->is_final_capture; - } + /** + * 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) + { + $this->amount = $amount; - /** - * State of the capture transaction. - * - * @param string $state - */ - public function setState($state) { - $this->state = $state; - return $this; - } + return $this; + } - /** - * State of the capture transaction. - * - * @return string - */ - public function getState() { - return $this->state; - } + /** + * 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() + { + return $this->amount; + } + /** + * 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) + { + $this->is_final_capture = $is_final_capture; - /** - * 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; - } + return $this; + } - /** - * ID of the Payment resource that this transaction is based on. - * - * @return string - */ - public function getParentPayment() { - return $this->parent_payment; - } + /** + * 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() + { + return $this->is_final_capture; + } - /** - * 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 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 Use setIsFinalCapture + * + * @return $this + */ + public function setIs_final_capture($is_final_capture) + { + $this->is_final_capture = $is_final_capture; - /** - * - * - * @array - * @param PayPal\Api\Links $links - */ - public function setLinks($links) { - $this->links = $links; - return $this; - } + return $this; + } - /** - * - * - * @return PayPal\Api\Links - */ - public function getLinks() { - return $this->links; - } + /** + * 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 + */ + public function getIs_final_capture() + { + return $this->is_final_capture; + } + /** + * Set State + * State of the capture transaction + * + * @param string $state + * + * @return $this + */ + public function setState($state) + { + $this->state = $state; + return $this; + } - /* - * Obtain the Capture transaction resource for the given identifier. - * - * @param string $captureId - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Capture - */ - 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; - } + /** + * Get State + * State of the capture transaction + * + * @return string + */ + public function getState() + { + return $this->state; + } - /* - * Creates (and processes) a new Refund Transaction added as a related resource. - * - * @param Refund $refund - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Refund - */ - 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; - } + /** + * 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 + */ + public function getLinks() + { + return $this->links; + } + + /** + * 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; + } + + /** + * 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; + } } diff --git a/lib/PayPal/Api/CreditCard.php b/lib/PayPal/Api/CreditCard.php index 0994e47..cf4073b 100644 --- a/lib/PayPal/Api/CreditCard.php +++ b/lib/PayPal/Api/CreditCard.php @@ -1,4 +1,5 @@ id = $id; - /** - * ID of the credit card being saved for later use. - * - * @param string $id - */ - public function setId($id) { - $this->id = $id; - return $this; - } + return $this; + } - /** - * ID of the credit card being saved for later use. - * - * @return string - */ - public function getId() { - return $this->id; - } + /** + * Get ID + * ID of the credit card being saved for later use + * + * @return string + */ + public function getId() + { + return $this->id; + } + /** + * Set Number + * Credit Card + * + * @param string $number + * + * @return $this + */ + public function setNumber($number) + { + $this->number = $number; - /** - * Card number. - * - * @param string $number - */ - public function setNumber($number) { - $this->number = $number; - return $this; - } + return $this; + } - /** - * Card number. - * - * @return string - */ - public function getNumber() { - return $this->number; - } + /** + * Get Number + * Credit Card + * + * @return string + */ + public function getNumber() + { + return $this->number; + } + /** + * Set Type + * (eg. Visa, Mastercard, etc) + * + * @param string $type + * + * @return $this + */ + public function setType($type) + { + $this->type = $type; - /** - * Type of the Card (eg. Visa, Mastercard, etc.). - * - * @param string $type - */ - public function setType($type) { - $this->type = $type; - return $this; - } + return $this; + } - /** - * Type of the Card (eg. Visa, Mastercard, etc.). - * - * @return string - */ - public function getType() { - return $this->type; - } + /** + * Get Type + * (eg. Visa, Mastercard, etc) + * + * @return mixed + */ + public function getType() + { + return $this->type; + } + /** + * Set Expire Month + * (eg. 1 - 12) + * + * @param int $expire_month + * + * @return $this + */ + public function setExpireMonth($expire_month) + { + $this->expire_month = $expire_month; - /** - * card expiry month with value 1 - 12. - * - * @param integer $expire_month - */ - public function setExpireMonth($expire_month) { - $this->expire_month = $expire_month; - return $this; - } + return $this; + } - /** - * card expiry month with value 1 - 12. - * - * @return integer - */ - public function getExpireMonth() { - return $this->expire_month; - } + /** + * Get Expire Month + * (eg. 1 - 12) + * + * @return int + */ + public function getExpireMonth() + { + return $this->expire_month; + } - /** - * card expiry month with value 1 - 12. - * - * @param integer $expire_month - * @deprecated. Instead use setExpireMonth - */ - 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 - */ - public function getExpire_month() { - return $this->expire_month; - } + /** + * Set Expire Month + * (eg. 1 - 12) + * + * @param int $expire_month + * + * @deprecated Use setExpireMonth + * + * @return $this + */ + public function setExpire_month($expire_month) + { + $this->expire_month = $expire_month; - /** - * 4 digit card expiry year - * - * @param integer $expire_year - */ - public function setExpireYear($expire_year) { - $this->expire_year = $expire_year; - return $this; - } + return $this; + } - /** - * 4 digit card expiry year - * - * @return integer - */ - public function getExpireYear() { - return $this->expire_year; - } + /** + * Get Expire Month + * (eg. 1 - 12) + * + * @deprecated Use getExpireMonth + * + * @return int + */ + public function getExpire_month() + { + return $this->expire_month; + } - /** - * 4 digit card expiry year - * - * @param integer $expire_year - * @deprecated. Instead use setExpireYear - */ - public function setExpire_year($expire_year) { - $this->expire_year = $expire_year; - return $this; - } - /** - * 4 digit card expiry year - * - * @return integer - * @deprecated. Instead use getExpireYear - */ - public function getExpire_year() { - return $this->expire_year; - } + /** + * Set Expire Year + * Four Digit + * + * @param int $expire_year + * + * @return $this + */ + public function setExpireYear($expire_year) + { + $this->expire_year = $expire_year; - /** - * Card validation code. Only supported when making a Payment but not when saving a credit card for future use. - * - * @param string $cvv2 - */ - public function setCvv2($cvv2) { - $this->cvv2 = $cvv2; - return $this; - } + return $this; + } - /** - * Card validation code. Only supported when making a Payment but not when saving a credit card for future use. - * - * @return string - */ - public function getCvv2() { - return $this->cvv2; - } + /** + * Get Expire Year + * Four Digit + * + * @return int + */ + public function getExpireYear() + { + return $this->expire_year; + } + /** + * Set Expire Year + * Four Digit + * + * @param int $expire_year + * + * @deprecated Use setExpireYear + * + * @return $this + */ + public function setExpire_year($expire_year) + { + $this->expire_year = $expire_year; - /** - * Card holder's first name. - * - * @param string $first_name - */ - public function setFirstName($first_name) { - $this->first_name = $first_name; - return $this; - } + return $this; + } - /** - * Card holder's first name. - * - * @return string - */ - public function getFirstName() { - return $this->first_name; - } + /** + * Get Expire Year + * Four Digit + * + * @deprecated Use getExpireYear + * + * @return int + */ + public function getExpire_year() + { + return $this->expire_year; + } - /** - * Card holder's first name. - * - * @param string $first_name - * @deprecated. Instead use setFirstName - */ - public function setFirst_name($first_name) { - $this->first_name = $first_name; - return $this; - } - /** - * Card holder's first name. - * - * @return string - * @deprecated. Instead use getFirstName - */ - public function getFirst_name() { - return $this->first_name; - } + /** + * 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) + { + $this->cvv2 = $cvv2; - /** - * Card holder's last name. - * - * @param string $last_name - */ - public function setLastName($last_name) { - $this->last_name = $last_name; - return $this; - } + return $this; + } - /** - * Card holder's last name. - * - * @return string - */ - public function getLastName() { - return $this->last_name; - } + /** + * 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() + { + return $this->cvv2; + } - /** - * Card holder's last name. - * - * @param string $last_name - * @deprecated. Instead use setLastName - */ - public function setLast_name($last_name) { - $this->last_name = $last_name; - return $this; - } - /** - * Card holder's last name. - * - * @return string - * @deprecated. Instead use getLastName - */ - public function getLast_name() { - return $this->last_name; - } + /** + * Set First Name + * Card holder's first name + * + * @param string $first_name + * + * @return $this + */ + public function setFirstName($first_name) + { + $this->first_name = $first_name; - /** - * Billing Address associated with this card. - * - * @param PayPal\Api\Address $billing_address - */ - public function setBillingAddress($billing_address) { - $this->billing_address = $billing_address; - return $this; - } + return $this; + } - /** - * Billing Address associated with this card. - * - * @return PayPal\Api\Address - */ - public function getBillingAddress() { - return $this->billing_address; - } + /** + * Get First Name + * Card holder's first name + * + * @return string + */ + public function getFirstName() + { + return $this->first_name; + } - /** - * Billing Address associated with this card. - * - * @param PayPal\Api\Address $billing_address - * @deprecated. Instead use setBillingAddress - */ - 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 - */ - public function getBilling_address() { - return $this->billing_address; - } + /** + * Set First Name + * Card holder's first name + * + * @param string $first_name + * + * @deprecated Use setFirstName + * + * @return $this + */ + public function setFirst_name($first_name) + { + $this->first_name = $first_name; - /** - * 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 - */ - public function setPayerId($payer_id) { - $this->payer_id = $payer_id; - return $this; - } + 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. - * - * @return string - */ - public function getPayerId() { - return $this->payer_id; - } + /** + * Get First Name + * Card holder's first name + * + * @deprecated Use getFirstName + * + * @return string + */ + public function getFirst_name() + { + return $this->first_name; + } - /** - * 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 - */ - 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. - * - * @return string - * @deprecated. Instead use getPayerId - */ - public function getPayer_id() { - return $this->payer_id; - } + /** + * Set Last Name + * Card holder's last name + * + * @param string $last_name + * + * @return $this + */ + public function setLastName($last_name) + { + $this->last_name = $last_name; - /** - * State of the funding instrument. - * - * @param string $state - */ - public function setState($state) { - $this->state = $state; - return $this; - } + return $this; + } - /** - * State of the funding instrument. - * - * @return string - */ - public function getState() { - return $this->state; - } + /** + * Get Last Name + * Card holder's last name + * + * @return string + */ + public function getLastName() + { + return $this->last_name; + } + /** + * Set Last Name + * Card holder's last name + * + * @param string $last_name + * + * @deprecated Use setLastName + * + * @return $this + */ + public function setLast_name($last_name) + { + $this->last_name = $last_name; - /** - * 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; - } + return $this; + } - /** - * Date/Time until this resource can be used fund a payment. - * - * @return string - */ - public function getValidUntil() { - return $this->valid_until; - } + /** + * Get Last Name + * Card holder's last name + * + * @deprecated Use getLastName + * + * @return string + */ + public function getLast_name() + { + return $this->last_name; + } - /** - * 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 Billing Address associated with this card + * + * @param \PayPal\Api\Address $billing_address + * + * @return $this + */ + public function setBillingAddress($billing_address) + { + $this->billing_address = $billing_address; - /** - * - * - * @array - * @param PayPal\Api\Links $links - */ - public function setLinks($links) { - $this->links = $links; - return $this; - } + return $this; + } - /** - * - * - * @return PayPal\Api\Links - */ - public function getLinks() { - return $this->links; - } + /** + * Billing Address associated with this card + * + * @return \PayPal\Api\Address + */ + public function getBillingAddress() + { + return $this->billing_address; + } + /** + * Set Billing Address associated with this card + * + * @param \PayPal\Api\Address $billing_address + * + * @deprecated Use setBillingAddress + * + * @return $this + */ + public function setBilling_address($billing_address) + { + $this->billing_address = $billing_address; + return $this; + } - /* - * Creates a new Credit Card Resource (aka Tokenize). - * - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return CreditCard - */ - 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; - } + /** + * Billing Address associated with this card + * + * @deprecated Use getBillingAddress + * + * @return \PayPal\Api\Address + */ + public function getBilling_address() + { + return $this->billing_address; + } - /* - * Obtain the Credit Card resource for the given identifier. - * - * @param string $creditCardId - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return CreditCard - */ - 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; - } + /** + * 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) + { + $this->payer_id = $payer_id; - /* - * Delete the Credit Card resource for the given identifier. - * - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return void - */ - 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); - return true; - } + return $this; + } - /* - * Update information in a previously saved card. Only the modified fields need to be passed in the request. - * - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return CreditCard - */ - public function update($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/vault/credit-card/{$this->getId()}", "PATCH", $payLoad); - $this->fromJson($json); - return $this; - } + /** + * 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() + { + return $this->payer_id; + } - /* - * Retrieves a list of Credit Card resources. - * - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return CreditCardHistory - */ - public static function all($apiContext = 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", "GET", $payLoad); - $ret = new CreditCardHistory(); - $ret->fromJson($json); - return $ret; - } + /** + * 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 Use setPayerId + * + * @return $this + */ + public function setPayer_id($payer_id) + { + $this->payer_id = $payer_id; + + return $this; + } + + /** + * 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 + */ + public function getPayer_id() + { + return $this->payer_id; + } + + /** + * Set State + * State of the funding instrument + * + * @param string $state + * + * @return $this + */ + public function setState($state) + { + $this->state = $state; + + return $this; + } + + /** + * Get State + * State of the funding instrument + * + * @return string + */ + public function getState() + { + return $this->state; + } + + /** + * Set Valid Until + * Date/Time until this resource can be used fund a payment + * + * @param string $valid_until + * + * @return $this + */ + 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 + */ + public function getLinks() + { + return $this->links; + } + + /** + * 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; + } + + /** + * 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; + } + + /** + * 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); + $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/{$this->getId()}", "DELETE", $payLoad); + + return true; + } } diff --git a/lib/PayPal/Api/CreditCardHistory.php b/lib/PayPal/Api/CreditCardHistory.php index ece20ee..9784ce8 100644 --- a/lib/PayPal/Api/CreditCardHistory.php +++ b/lib/PayPal/Api/CreditCardHistory.php @@ -1,108 +1,155 @@ {"credit-cards"} = $credit_cards; - return $this; - } +/** + * Class CreditCardHistory + * + * @property int count + * @property string next_id + */ +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; - /** - * A list of credit card resources - * - * @return PayPal\Api\CreditCard - */ - public function getCreditCards() { - return $this->{"credit-cards"}; - } + return $this; + } - /** - * A list of credit card resources - * - * @array - * @param PayPal\Api\CreditCard $credit-cards - * @deprecated. Instead use setCreditCards - */ - public function setCredit_cards($credit_cards) { - $this->{"credit-cards"} = $credit_cards; - return $this; - } - /** - * A list of credit card resources - * - * @return PayPal\Api\CreditCard - * @deprecated. Instead use getCreditCards - */ - public function getCredit_cards() { - return $this->{"credit-cards"}; - } + /** + * Get Credit Cards + * A list of credit card resources + * + * @return \PayPal\Api\CreditCard + */ + public function getCreditCards() + { + 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 - */ - public function setCount($count) { - $this->count = $count; - return $this; - } + /** + * Set Credit Cards + * A list of credit card resources + * + * @param \PayPal\Api\CreditCard $credit_cards + * + * @deprecated Use setCreditCards + * + * @return $this + */ + public function setCredit_cards($credit_cards) + { + $this->{"credit-cards"} = $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. - * - * @return integer - */ - public function getCount() { - return $this->count; - } + return $this; + } + /** + * Get Credit Cards + * A list of credit card resources + * + * @deprecated Use getCreditCards + * + * @return \PayPal\Api\CreditCard + */ + public function getCredit_cards() + { + return $this->{"credit-cards"}; + } - /** - * Identifier of the next element to get the next range of results. - * - * @param string $next_id - */ - public function setNextId($next_id) { - $this->next_id = $next_id; - return $this; - } + /** + * 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) + { + $this->count = $count; - /** - * Identifier of the next element to get the next range of results. - * - * @return string - */ - public function getNextId() { - return $this->next_id; - } + return $this; + } - /** - * Identifier of the next element to get the next range of results. - * - * @param string $next_id - * @deprecated. Instead use setNextId - */ - 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. - * - * @return string - * @deprecated. Instead use getNextId - */ - public function getNext_id() { - return $this->next_id; - } + /** + * 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() + { + return $this->count; + } + /** + * 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) + { + $this->next_id = $next_id; + + return $this; + } + + /** + * Get Next ID + * Identifier of the next element to get the next range of results + * + * @return string + */ + public function getNextId() + { + return $this->next_id; + } + + /** + * Set Next ID + * Identifier of the next element to get the next range of results + * + * @param string $next_id + * + * @deprecated Use setNextId + * + * @return $this + */ + public function setNext_id($next_id) + { + $this->next_id = $next_id; + + return $this; + } + + /** + * Get Next ID + * Identifier of the next element to get the next range of results + * + * @deprecated Use getNextId + * + * @return string + */ + public function getNext_id() + { + return $this->next_id; + } } diff --git a/lib/PayPal/Api/CreditCardToken.php b/lib/PayPal/Api/CreditCardToken.php index 6e8c204..a7c5bae 100644 --- a/lib/PayPal/Api/CreditCardToken.php +++ b/lib/PayPal/Api/CreditCardToken.php @@ -1,204 +1,297 @@ credit_card_id = $credit_card_id; - return $this; - } +/** + * 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 + */ +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; - /** - * ID of a previously saved Credit Card resource using /vault/credit-card API. - * - * @return string - */ - public function getCreditCardId() { - return $this->credit_card_id; - } + return $this; + } - /** - * ID of a previously saved Credit Card resource using /vault/credit-card API. - * - * @param string $credit_card_id - * @deprecated. Instead use setCreditCardId - */ - 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. - * - * @return string - * @deprecated. Instead use getCreditCardId - */ - public function getCredit_card_id() { - return $this->credit_card_id; - } + /** + * Get Credit Card ID + * ID of a previously saved Credit Card resource using /vault/credit-card API + * + * @return string + */ + public function getCreditCardId() + { + return $this->credit_card_id; + } - /** - * The unique identifier of the payer used when saving this credit card using /vault/credit-card API. - * - * @param string $payer_id - */ - public function setPayerId($payer_id) { - $this->payer_id = $payer_id; - return $this; - } + /** + * Set Credit Card ID + * ID of a previously saved Credit Card resource using /vault/credit-card API + * + * @param string $credit_card_id + * + * @deprecated Use setCreditCardId + * + * @return $this + */ + public function setCredit_card_id($credit_card_id) + { + $this->credit_card_id = $credit_card_id; - /** - * The unique identifier of the payer used when saving this credit card using /vault/credit-card API. - * - * @return string - */ - public function getPayerId() { - return $this->payer_id; - } + return $this; + } - /** - * 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 - */ - 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. - * - * @return string - * @deprecated. Instead use getPayerId - */ - public function getPayer_id() { - return $this->payer_id; - } + /** + * Get Credit Card ID + * ID of a previously saved Credit Card resource using /vault/credit-card API + * + * @deprecated Use getCreditCardId + * + * @return string + */ + public function getCredit_card_id() + { + return $this->credit_card_id; + } - /** - * Last 4 digits of the card number from the saved card. - * - * @param string $last4 - */ - public function setLast4($last4) { - $this->last4 = $last4; - return $this; - } + /** + * 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) + { + $this->payer_id = $payer_id; - /** - * Last 4 digits of the card number from the saved card. - * - * @return string - */ - public function getLast4() { - return $this->last4; - } + return $this; + } + /** + * 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() + { + return $this->payer_id; + } - /** - * 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. - * - * @param string $type - */ - public function setType($type) { - $this->type = $type; - return $this; - } + /** + * 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 Use setPayerId + * + * @return $this + */ + public function setPayer_id($payer_id) + { + $this->payer_id = $payer_id; - /** - * 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. - * - * @return string - */ - public function getType() { - return $this->type; - } + return $this; + } + /** + * 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 + */ + public function getPayer_id() + { + return $this->payer_id; + } - /** - * card expiry month from the saved card with value 1 - 12 - * - * @param integer $expire_month - */ - public function setExpireMonth($expire_month) { - $this->expire_month = $expire_month; - return $this; - } + /** + * Set Last Four + * Last 4 digits of the card number from the saved card + * + * @param string $last4 + * + * @return $this + */ + public function setLast4($last4) + { + $this->last4 = $last4; - /** - * card expiry month from the saved card with value 1 - 12 - * - * @return integer - */ - public function getExpireMonth() { - return $this->expire_month; - } + return $this; + } - /** - * card expiry month from the saved card with value 1 - 12 - * - * @param integer $expire_month - * @deprecated. Instead use setExpireMonth - */ - 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 - */ - public function getExpire_month() { - return $this->expire_month; - } + /** + * Get Last Four + * Last 4 digits of the card number from the saved card + * + * @return string + */ + public function getLast4() + { + return $this->last4; + } - /** - * 4 digit card expiry year from the saved card - * - * @param integer $expire_year - */ - public function setExpireYear($expire_year) { - $this->expire_year = $expire_year; - return $this; - } + /** + * 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) + { + $this->type = $type; - /** - * 4 digit card expiry year from the saved card - * - * @return integer - */ - public function getExpireYear() { - return $this->expire_year; - } + return $this; + } - /** - * 4 digit card expiry year from the saved card - * - * @param integer $expire_year - * @deprecated. Instead use setExpireYear - */ - public function setExpire_year($expire_year) { - $this->expire_year = $expire_year; - return $this; - } - /** - * 4 digit card expiry year from the saved card - * - * @return integer - * @deprecated. Instead use getExpireYear - */ - public function getExpire_year() { - return $this->expire_year; - } + /** + * 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() + { + return $this->type; + } + /** + * 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) + { + $this->expire_month = $expire_month; + + return $this; + } + + /** + * Get Expire Month + * Card Expiration month from the saved card with value 1 - 12 + * + * @return int + */ + public function getExpireMonth() + { + return $this->expire_month; + } + + /** + * 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) + { + $this->expire_month = $expire_month; + + return $this; + } + + /** + * Get Expire Month + * Card Expiration month from the saved card with value 1 - 12 + * + * @deprecated Use getExpireMonth + * + * @return int + */ + public function getExpire_month() + { + return $this->expire_month; + } + + /** + * Set Expire Year + * 4 digit card expiry year from the saved card + * + * @param int $expire_year + * + * @return $this + */ + 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 int + */ + public function getExpireYear() + { + return $this->expire_year; + } + + /** + * Set Expire Year + * 4 digit card expiry year from the saved card + * + * @param int $expire_year + * + * @deprecated Use setExpireYear + * + * @return $this + */ + 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 + * + * @deprecated Use getExpireYear + * + * @return int + */ + public function getExpire_year() + { + return $this->expire_year; + } } diff --git a/lib/PayPal/Api/Details.php b/lib/PayPal/Api/Details.php index e352b7d..960f46d 100644 --- a/lib/PayPal/Api/Details.php +++ b/lib/PayPal/Api/Details.php @@ -1,88 +1,119 @@ shipping = $shipping; - return $this; - } +/** + * Class Details + * + * @property string shipping + * @property string subtotal + * @property string tax + * @property string fee + */ +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. - * - * @return string - */ - public function getShipping() { - return $this->shipping; - } + /** + * Get Shipping + * Amount being charged for shipping + * + * @return string + */ + public function getShipping() + { + return $this->shipping; + } + /** + * Set Subtotal + * Sub-total (amount) of items being paid for + * + * @param string $subtotal + * + * @return $this + */ + public function setSubtotal($subtotal) + { + $this->subtotal = $subtotal; + return $this; + } - /** - * Sub-total (amount) of items being paid for. - * - * @param string $subtotal - */ - public function setSubtotal($subtotal) { - $this->subtotal = $subtotal; - return $this; - } + /** + * Get Subtotal + * Sub-total (amount) of items being paid for + * + * @return string + */ + public function getSubtotal() + { + return $this->subtotal; + } - /** - * Sub-total (amount) of items being paid for. - * - * @return string - */ - public function getSubtotal() { - return $this->subtotal; - } + /** + * Set Tax + * Amount being charged as tax + * + * @param string $tax + * + * @return $this + */ + public function setTax($tax) + { + $this->tax = $tax; + return $this; + } + /** + * Get Tax + * Amount being charged as tax + * + * @return string + */ + public function getTax() + { + return $this->tax; + } - /** - * Amount being charged as tax. - * - * @param string $tax - */ - public function setTax($tax) { - $this->tax = $tax; - return $this; - } - - /** - * Amount being charged as tax. - * - * @return string - */ - 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. - * - * @param string $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. - * - * @return string - */ - public function getFee() { - return $this->fee; - } - + /** + * 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) + { + $this->fee = $fee; + return $this; + } + /** + * 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() + { + return $this->fee; + } } diff --git a/lib/PayPal/Api/FundingInstrument.php b/lib/PayPal/Api/FundingInstrument.php index 0bf4f3a..4df85be 100644 --- a/lib/PayPal/Api/FundingInstrument.php +++ b/lib/PayPal/Api/FundingInstrument.php @@ -1,86 +1,119 @@ credit_card = $credit_card; - return $this; - } +/** + * Class FundingInstrument + * + * @property \PayPal\Api\CreditCard credit_card + * @property \PayPal\Api\CreditCardToken credit_card_token + */ +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; - /** - * Credit Card information. - * - * @return PayPal\Api\CreditCard - */ - public function getCreditCard() { - return $this->credit_card; - } + return $this; + } - /** - * Credit Card information. - * - * @param PayPal\Api\CreditCard $credit_card - * @deprecated. Instead use setCreditCard - */ - public function setCredit_card($credit_card) { - $this->credit_card = $credit_card; - return $this; - } - /** - * Credit Card information. - * - * @return PayPal\Api\CreditCard - * @deprecated. Instead use getCreditCard - */ - public function getCredit_card() { - return $this->credit_card; - } + /** + * Get Credit Card + * + * @return \PayPal\Api\CreditCard + */ + public function getCreditCard() + { + return $this->credit_card; + } - /** - * Credit Card information. - * - * @param PayPal\Api\CreditCardToken $credit_card_token - */ - public function setCreditCardToken($credit_card_token) { - $this->credit_card_token = $credit_card_token; - return $this; - } + /** + * Set Credit Card + * + * @param \PayPal\Api\CreditCard $credit_card + * + * @deprecated Use setCreditCard + * + * @return $this + */ + public function setCredit_card($credit_card) + { + $this->credit_card = $credit_card; - /** - * Credit Card information. - * - * @return PayPal\Api\CreditCardToken - */ - public function getCreditCardToken() { - return $this->credit_card_token; - } + return $this; + } - /** - * Credit Card information. - * - * @param PayPal\Api\CreditCardToken $credit_card_token - * @deprecated. Instead use setCreditCardToken - */ - 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 - */ - public function getCredit_card_token() { - return $this->credit_card_token; - } + /** + * Get Credit Card + * + * @deprecated Use getCreditCard + * + * @return \PayPal\Api\CreditCard + */ + public function getCredit_card() + { + return $this->credit_card; + } + /** + * Set Credit Card Token + * + * @param \PayPal\Api\CreditCardToken $credit_card_token + * + * @return $this + */ + public function setCreditCardToken($credit_card_token) + { + $this->credit_card_token = $credit_card_token; + + return $this; + } + + /** + * Get Credit Card Token + * + * @return \PayPal\Api\CreditCardToken + */ + public function getCreditCardToken() + { + return $this->credit_card_token; + } + + /** + * Set Credit Card Token + * + * @param \PayPal\Api\CreditCardToken $credit_card_token + * + * @deprecated Use setCreditCardToken + * + * @return $this + */ + public function setCredit_card_token($credit_card_token) + { + $this->credit_card_token = $credit_card_token; + + return $this; + } + + /** + * Get Credit Card Token + * + * @deprecated Use getCreditCardToken + * + * @return \PayPal\Api\CreditCardToken + */ + public function getCredit_card_token() + { + return $this->credit_card_token; + } } diff --git a/lib/PayPal/Api/HyperSchema.php b/lib/PayPal/Api/HyperSchema.php index 2b8e9a6..2d8dd8b 100644 --- a/lib/PayPal/Api/HyperSchema.php +++ b/lib/PayPal/Api/HyperSchema.php @@ -1,129 +1,163 @@ links = $links; - return $this; - } +/** + * Class HyperSchema + * + * @property \PayPal\Api\Links links + * @property string fragmentResolution + * @property bool readonly + * @property string contentEncoding + * @property string pathStart + * @property string mediaType + */ +class HyperSchema extends PPModel +{ + /** + * Set Links + * + * @param \PayPal\Api\Links $links + * + * @return $this + */ + public function setLinks($links) + { + $this->links = $links; - /** - * - * - * @return PayPal\Api\Links - */ - public function getLinks() { - return $this->links; - } + return $this; + } + /** + * Get Links + * + * @return \PayPal\Api\Links + */ + public function getLinks() + { + return $this->links; + } - /** - * - * - * @param string $fragmentResolution - */ - public function setFragmentResolution($fragmentResolution) { - $this->fragmentResolution = $fragmentResolution; - return $this; - } + /** + * Set Fragment Resolution + * + * @param string $fragmentResolution + * + * @return $this + */ + public function setFragmentResolution($fragmentResolution) + { + $this->fragmentResolution = $fragmentResolution; - /** - * - * - * @return string - */ - public function getFragmentResolution() { - return $this->fragmentResolution; - } + return $this; + } + /** + * Get Fragment Resolution + * + * @return string + */ + public function getFragmentResolution() + { + return $this->fragmentResolution; + } - /** - * - * - * @param boolean $readonly - */ - public function setReadonly($readonly) { - $this->readonly = $readonly; - return $this; - } + /** + * Set Read Only + * + * @param bool $readonly + * + * @return $this + */ + public function setReadonly($readonly) + { + $this->readonly = $readonly; - /** - * - * - * @return boolean - */ - public function getReadonly() { - return $this->readonly; - } + return $this; + } + /** + * Get Read Only + * + * @return bool + */ + public function getReadonly() + { + return $this->readonly; + } - /** - * - * - * @param string $contentEncoding - */ - public function setContentEncoding($contentEncoding) { - $this->contentEncoding = $contentEncoding; - return $this; - } + /** + * Set Content Encoding + * + * @param string $contentEncoding + * + * @return $this + */ + public function setContentEncoding($contentEncoding) + { + $this->contentEncoding = $contentEncoding; - /** - * - * - * @return string - */ - public function getContentEncoding() { - return $this->contentEncoding; - } + return $this; + } + /** + * Get Content Encoding + * + * @return string + */ + public function getContentEncoding() + { + return $this->contentEncoding; + } - /** - * - * - * @param string $pathStart - */ - public function setPathStart($pathStart) { - $this->pathStart = $pathStart; - return $this; - } + /** + * Set Path Start + * + * @param string $pathStart + * + * @return $this + */ + public function setPathStart($pathStart) + { + $this->pathStart = $pathStart; - /** - * - * - * @return string - */ - public function getPathStart() { - return $this->pathStart; - } + return $this; + } + /** + * Get Path Start + * + * @return string + */ + public function getPathStart() + { + return $this->pathStart; + } - /** - * - * - * @param string $mediaType - */ - public function setMediaType($mediaType) { - $this->mediaType = $mediaType; - return $this; - } - - /** - * - * - * @return string - */ - public function getMediaType() { - return $this->mediaType; - } + /** + * Set Media Type + * + * @param string $mediaType + * + * @return $this + */ + public function setMediaType($mediaType) + { + $this->mediaType = $mediaType; + return $this; + } + /** + * Get Media Type + * + * @return string + */ + public function getMediaType() + { + return $this->mediaType; + } } diff --git a/lib/PayPal/Api/Item.php b/lib/PayPal/Api/Item.php index 081650b..f6a0aa0 100644 --- a/lib/PayPal/Api/Item.php +++ b/lib/PayPal/Api/Item.php @@ -1,108 +1,148 @@ quantity = $quantity; - return $this; - } +/** + * Class Item + * + * @property string quantity + * @property string name + * @property string price + * @property string currency + * @property string sku + */ +class Item extends PPModel +{ + /** + * Set Quantity + * Number of items + * + * @param string $quantity + * + * @return $this + */ + public function setQuantity($quantity) + { + $this->quantity = $quantity; - /** - * Number of items. - * - * @return string - */ - public function getQuantity() { - return $this->quantity; - } + return $this; + } + /** + * Get Quantity + * Number of items + * + * @return string + */ + public function getQuantity() + { + return $this->quantity; + } - /** - * Name of the item. - * - * @param string $name - */ - public function setName($name) { - $this->name = $name; - return $this; - } + /** + * Set Name + * Name of the item + * + * @param string $name + * + * @return $this + */ + public function setName($name) + { + $this->name = $name; - /** - * Name of the item. - * - * @return string - */ - public function getName() { - return $this->name; - } + return $this; + } + /** + * Get Name + * Name of the item + * + * @return string + */ + public function getName() + { + return $this->name; + } - /** - * Cost of the item. - * - * @param string $price - */ - public function setPrice($price) { - $this->price = $price; - return $this; - } + /** + * Set Price + * Cost of the item + * + * @param string $price + * + * @return $this + */ + public function setPrice($price) + { + $this->price = $price; - /** - * Cost of the item. - * - * @return string - */ - public function getPrice() { - return $this->price; - } + return $this; + } + /** + * Get Price + * Cost of the item + * + * @return string + */ + public function getPrice() + { + return $this->price; + } - /** - * 3-letter Currency Code - * - * @param string $currency - */ - public function setCurrency($currency) { - $this->currency = $currency; - return $this; - } + /** + * Set Currency + * Three Letter Currency Code + * + * @param string $currency + * + * @return $this + */ + public function setCurrency($currency) + { + $this->currency = $currency; - /** - * 3-letter Currency Code - * - * @return string - */ - public function getCurrency() { - return $this->currency; - } + return $this; + } + /** + * Get Currency + * Three Letter Currency Code + * + * @return string + */ + public function getCurrency() + { + return $this->currency; + } - /** - * Number or code to identify the item in your catalog/records. - * - * @param string $sku - */ - public function setSku($sku) { - $this->sku = $sku; - return $this; - } - - /** - * Number or code to identify the item in your catalog/records. - * - * @return string - */ - public function getSku() { - return $this->sku; - } + /** + * Set SKU + * Number or code to identify the item in your catalog/records + * + * @param string $sku + * + * @return $this + */ + public function setSku($sku) + { + $this->sku = $sku; + return $this; + } + /** + * Get SKI + * Number or code to identify the item in your catalog/records + * + * @return string + */ + public function getSku() + { + return $this->sku; + } } diff --git a/lib/PayPal/Api/ItemList.php b/lib/PayPal/Api/ItemList.php index 7254b98..690e5f7 100644 --- a/lib/PayPal/Api/ItemList.php +++ b/lib/PayPal/Api/ItemList.php @@ -1,68 +1,93 @@ items = $items; - return $this; - } +/** + * Class ItemList + * + * @property array|\PayPal\Api\Item items + * @property \PayPal\Api\ShippingAddress shipping_address + */ +class ItemList extends PPModel +{ + /** + * Set Items + * List of Items + * + * @param array|\PayPal\Api\Item $items + * + * @return $this + */ + public function setItems($items) + { + $this->items = $items; - /** - * List of items. - * - * @return PayPal\Api\Item - */ - public function getItems() { - return $this->items; - } + return $this; + } + /** + * Get Items + * List of items + * + * @return \PayPal\Api\Item + */ + public function getItems() + { + return $this->items; + } - /** - * Shipping address. - * - * @param PayPal\Api\ShippingAddress $shipping_address - */ - public function setShippingAddress($shipping_address) { - $this->shipping_address = $shipping_address; - return $this; - } + /** + * Set Shipping Address + * + * @param \PayPal\Api\ShippingAddress $shipping_address + * + * @return $this + */ + public function setShippingAddress($shipping_address) + { + $this->shipping_address = $shipping_address; - /** - * Shipping address. - * - * @return PayPal\Api\ShippingAddress - */ - public function getShippingAddress() { - return $this->shipping_address; - } + return $this; + } - /** - * Shipping address. - * - * @param PayPal\Api\ShippingAddress $shipping_address - * @deprecated. Instead use setShippingAddress - */ - public function setShipping_address($shipping_address) { - $this->shipping_address = $shipping_address; - return $this; - } - /** - * Shipping address. - * - * @return PayPal\Api\ShippingAddress - * @deprecated. Instead use getShippingAddress - */ - public function getShipping_address() { - return $this->shipping_address; - } + /** + * Get Shipping Address + * + * @return \PayPal\Api\ShippingAddress + */ + public function getShippingAddress() + { + return $this->shipping_address; + } + /** + * Set Shipping Address + * + * @param \PayPal\Api\ShippingAddress $shipping_address + * + * @deprecated Use setShippingAddress + * + * @return $this + */ + public function setShipping_address($shipping_address) + { + $this->shipping_address = $shipping_address; + + return $this; + } + + /** + * Get Shipping Address + * + * @deprecated Use getShippingAddress + * + * @return \PayPal\Api\ShippingAddress + */ + public function getShipping_address() + { + return $this->shipping_address; + } } diff --git a/lib/PayPal/Api/Links.php b/lib/PayPal/Api/Links.php index a4ee5e7..a5b0feb 100644 --- a/lib/PayPal/Api/Links.php +++ b/lib/PayPal/Api/Links.php @@ -1,128 +1,163 @@ href = $href; - return $this; - } +/** + * 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) + { + $this->href = $href; - /** - * - * - * @return string - */ - public function getHref() { - return $this->href; - } + return $this; + } + /** + * Get Href + * + * @return string + */ + public function getHref() + { + return $this->href; + } - /** - * - * - * @param string $rel - */ - public function setRel($rel) { - $this->rel = $rel; - return $this; - } + /** + * Set Rel + * + * @param string $rel + * + * @return $this + */ + public function setRel($rel) + { + $this->rel = $rel; - /** - * - * - * @return string - */ - public function getRel() { - return $this->rel; - } + return $this; + } + /** + * Get Rel + * + * @return string + */ + public function getRel() + { + return $this->rel; + } - /** - * - * - * @param PayPal\Api\HyperSchema $targetSchema - */ - public function setTargetSchema($targetSchema) { - $this->targetSchema = $targetSchema; - return $this; - } + /** + * Set Target Schema + * + * @param \PayPal\Api\HyperSchema $targetSchema + * + * @return $this + */ + public function setTargetSchema($targetSchema) + { + $this->targetSchema = $targetSchema; - /** - * - * - * @return PayPal\Api\HyperSchema - */ - public function getTargetSchema() { - return $this->targetSchema; - } + return $this; + } + /** + * Get Target Schema + * + * @return \PayPal\Api\HyperSchema + */ + public function getTargetSchema() + { + return $this->targetSchema; + } - /** - * - * - * @param string $method - */ - public function setMethod($method) { - $this->method = $method; - return $this; - } + /** + * Set Method + * + * @param string $method + * + * @return $this + */ + public function setMethod($method) + { + $this->method = $method; - /** - * - * - * @return string - */ - public function getMethod() { - return $this->method; - } + return $this; + } + /** + * Get Method + * + * @return string + */ + public function getMethod() + { + return $this->method; + } - /** - * - * - * @param string $enctype - */ - public function setEnctype($enctype) { - $this->enctype = $enctype; - return $this; - } + /** + * Set Enctype + * + * @param string $enctype + * + * @return $this + */ + public function setEnctype($enctype) + { + $this->enctype = $enctype; - /** - * - * - * @return string - */ - public function getEnctype() { - return $this->enctype; - } + return $this; + } + /** + * Get Enctype + * + * @return string + */ + public function getEnctype() + { + return $this->enctype; + } - /** - * - * - * @param PayPal\Api\HyperSchema $schema - */ - public function setSchema($schema) { - $this->schema = $schema; - return $this; - } - - /** - * - * - * @return PayPal\Api\HyperSchema - */ - public function getSchema() { - return $this->schema; - } + /** + * Set Schema + * + * @param \PayPal\Api\HyperSchema $schema + * + * @return $this + */ + public function setSchema($schema) + { + $this->schema = $schema; + return $this; + } + /** + * Get Schema + * + * @return \PayPal\Api\HyperSchema + */ + public function getSchema() + { + return $this->schema; + } } diff --git a/lib/PayPal/Api/Payee.php b/lib/PayPal/Api/Payee.php index 97b3cab..39c0b3b 100644 --- a/lib/PayPal/Api/Payee.php +++ b/lib/PayPal/Api/Payee.php @@ -1,87 +1,130 @@ email = $email; - return $this; - } +/** + * Class Payee + * + * @property string email + * @property string merchant_id + * @property string phone + */ +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; - /** - * 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() { - return $this->email; - } + return $this; + } + /** + * 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() + { + return $this->email; + } - /** - * Encrypted PayPal Account identifier for the Payee. - * - * @param string $merchant_id - */ - public function setMerchantId($merchant_id) { - $this->merchant_id = $merchant_id; - return $this; - } + /** + * Set Merchant ID + * Encrypted PayPal Account identifier for the Payee + * + * @param string $merchant_id + * + * @return $this + */ + public function setMerchantId($merchant_id) + { + $this->merchant_id = $merchant_id; + return $this; + } - /** - * Encrypted PayPal Account identifier for the Payee. - * - * @return string - */ - public function getMerchantId() { - return $this->merchant_id; - } + /** + * Get Merchant ID + * Encrypted PayPal Account identifier for the Payee + * + * @return string + */ + public function getMerchantId() + { + return $this->merchant_id; + } - /** - * Encrypted PayPal Account identifier for the Payee. - * - * @param string $merchant_id - * @deprecated. Instead use setMerchantId - */ - public function setMerchant_id($merchant_id) { - $this->merchant_id = $merchant_id; - return $this; - } - /** - * Encrypted PayPal Account identifier for the Payee. - * - * @return string - * @deprecated. Instead use getMerchantId - */ - public function getMerchant_id() { - return $this->merchant_id; - } + /** + * Set Merchant ID + * Encrypted PayPal Account identifier for the Payee + * + * @param string $merchant_id + * + * @deprecated Use setMerchantId + * + * @return $this + */ + public function setMerchant_id($merchant_id) + { + $this->merchant_id = $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. - * - * @param string $phone - */ - public function setPhone($phone) { - $this->phone = $phone; - return $this; - } + 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. - * - * @return string - */ - public function getPhone() { - return $this->phone; - } + /** + * Get Merchant ID + * Encrypted PayPal Account identifier for the Payee + * + * @deprecated Use getMerchantId + * + * @return string + */ + public function getMerchant_id() + { + return $this->merchant_id; + } + /** + * 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) + { + $this->phone = $phone; + return $this; + } + /** + * 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() + { + return $this->phone; + } } diff --git a/lib/PayPal/Api/Payer.php b/lib/PayPal/Api/Payer.php index 6e9b726..cfe5d95 100644 --- a/lib/PayPal/Api/Payer.php +++ b/lib/PayPal/Api/Payer.php @@ -1,127 +1,182 @@ payment_method = $payment_method; - return $this; - } +/** + * Class Payer + * + * @property string payment_method + * @property array|\PayPal\Api\FundingInstrument funding_instruments + * @property \PayPal\Api\PayerInfo payer_info + */ +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; - /** - * Payment method being used - PayPal Wallet payment or Direct Credit card. - * - * @return string - */ - public function getPaymentMethod() { - return $this->payment_method; - } + return $this; + } - /** - * Payment method being used - PayPal Wallet payment or Direct Credit card. - * - * @param string $payment_method - * @deprecated. Instead use setPaymentMethod - */ - public function setPayment_method($payment_method) { - $this->payment_method = $payment_method; - return $this; - } - /** - * Payment method being used - PayPal Wallet payment or Direct Credit card. - * - * @return string - * @deprecated. Instead use getPaymentMethod - */ - public function getPayment_method() { - return $this->payment_method; - } + /** + * Get Payment Method + * Payment method being used - PayPal Wallet payment or Direct Credit card + * + * @return string + */ + public function getPaymentMethod() + { + 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 - */ - public function setFundingInstruments($funding_instruments) { - $this->funding_instruments = $funding_instruments; - return $this; - } + /** + * Set Payment Method + * Payment method being used - PayPal Wallet payment or Direct Credit card + * + * @param string $payment_method + * + * @deprecated Use setPaymentMethod + * + * @return $this + */ + public function setPayment_method($payment_method) + { + $this->payment_method = $payment_method; - /** - * List of funding instruments from where the funds of the current payment come from. Typically a credit card. - * - * @return PayPal\Api\FundingInstrument - */ - public function getFundingInstruments() { - return $this->funding_instruments; - } + return $this; + } - /** - * 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 - */ - 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 - */ - public function getFunding_instruments() { - return $this->funding_instruments; - } + /** + * Get Payment Method + * Payment method being used - PayPal Wallet payment or Direct Credit card + * + * @deprecated Use getPaymentMethod + * + * @return string + */ + public function getPayment_method() + { + return $this->payment_method; + } - /** - * 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 - */ - public function setPayerInfo($payer_info) { - $this->payer_info = $payer_info; - return $this; - } + /** + * 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) + { + $this->funding_instruments = $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. - * - * @return PayPal\Api\PayerInfo - */ - public function getPayerInfo() { - return $this->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. - * - * @param PayPal\Api\PayerInfo $payer_info - * @deprecated. Instead use setPayerInfo - */ - 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 - */ - public function getPayer_info() { - return $this->payer_info; - } + /** + * Get Funding Instruments + * + * @return \PayPal\Api\FundingInstrument|array + */ + public function getFundingInstruments() + { + return $this->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 $funding_instruments + * + * @deprecated Use setFundingInstruments + * + * @return $this + */ + public function setFunding_instruments($funding_instruments) + { + $this->funding_instruments = $funding_instruments; + + return $this; + } + + /** + * Get Funding Instruments + * + * @deprecated Use getFundingInstruments + * + * @return \PayPal\Api\FundingInstrument + */ + public function getFunding_instruments() + { + return $this->funding_instruments; + } + + /** + * 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) + { + $this->payer_info = $payer_info; + + return $this; + } + + /** + * Get Payer Info + * + * @return \PayPal\Api\PayerInfo + */ + public function getPayerInfo() + { + return $this->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 + * + * @deprecated Use setPayerInfo + * + * @return $this + */ + public function setPayer_info($payer_info) + { + $this->payer_info = $payer_info; + + return $this; + } + + /** + * Get Payer Info + * + * @deprecated Use getPayerInfo + * + * @return \PayPal\Api\PayerInfo + */ + public function getPayer_info() + { + return $this->payer_info; + } } diff --git a/lib/PayPal/Api/PayerInfo.php b/lib/PayPal/Api/PayerInfo.php index 8d1a5a6..2cc9c98 100644 --- a/lib/PayPal/Api/PayerInfo.php +++ b/lib/PayPal/Api/PayerInfo.php @@ -1,204 +1,295 @@ email = $email; - return $this; - } +/** + * 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 + */ +class PayerInfo extends PPModel +{ + /** + * Set Email + * Email address representing the Payer + * + * @param string $email + * + * @return $this + */ + public function setEmail($email) + { + $this->email = $email; - /** - * Email address representing the Payer. - * - * @return string - */ - public function getEmail() { - return $this->email; - } + return $this; + } + /** + * Get Email + * Email address representing the Payer + * + * @return string + */ + public function getEmail() + { + return $this->email; + } - /** - * First Name of the Payer from their PayPal Account. - * - * @param string $first_name - */ - public function setFirstName($first_name) { - $this->first_name = $first_name; - return $this; - } + /** + * Set First Name + * First Name of the Payer from their PayPal Account + * + * @param string $first_name + * + * @return $this + */ + public function setFirstName($first_name) + { + $this->first_name = $first_name; - /** - * First Name of the Payer from their PayPal Account. - * - * @return string - */ - public function getFirstName() { - return $this->first_name; - } + return $this; + } - /** - * First Name of the Payer from their PayPal Account. - * - * @param string $first_name - * @deprecated. Instead use setFirstName - */ - public function setFirst_name($first_name) { - $this->first_name = $first_name; - return $this; - } - /** - * First Name of the Payer from their PayPal Account. - * - * @return string - * @deprecated. Instead use getFirstName - */ - public function getFirst_name() { - return $this->first_name; - } + /** + * Get First Name + * First Name of the Payer from their PayPal Account + * + * @return string + */ + public function getFirstName() + { + return $this->first_name; + } - /** - * Last Name of the Payer from their PayPal Account. - * - * @param string $last_name - */ - public function setLastName($last_name) { - $this->last_name = $last_name; - return $this; - } + /** + * Set First Name + * First Name of the Payer from their PayPal Account + * + * @param string $first_name + * + * @deprecated Use setFirstName + * + * @return $this + */ + public function setFirst_name($first_name) + { + $this->first_name = $first_name; - /** - * Last Name of the Payer from their PayPal Account. - * - * @return string - */ - public function getLastName() { - return $this->last_name; - } + return $this; + } - /** - * Last Name of the Payer from their PayPal Account. - * - * @param string $last_name - * @deprecated. Instead use setLastName - */ - public function setLast_name($last_name) { - $this->last_name = $last_name; - return $this; - } - /** - * Last Name of the Payer from their PayPal Account. - * - * @return string - * @deprecated. Instead use getLastName - */ - public function getLast_name() { - return $this->last_name; - } + /** + * Get First Name + * First Name of the Payer from their PayPal Account + * + * @deprecated Use getFirstName + * + * @return string + */ + public function getFirst_name() + { + return $this->first_name; + } - /** - * PayPal assigned Payer ID. - * - * @param string $payer_id - */ - public function setPayerId($payer_id) { - $this->payer_id = $payer_id; - return $this; - } + /** + * Set Last Name + * Last Name of the Payer from their PayPal Account + * + * @param string $last_name + * + * @return $this + */ + public function setLastName($last_name) + { + $this->last_name = $last_name; - /** - * PayPal assigned Payer ID. - * - * @return string - */ - public function getPayerId() { - return $this->payer_id; - } + return $this; + } - /** - * PayPal assigned Payer ID. - * - * @param string $payer_id - * @deprecated. Instead use setPayerId - */ - public function setPayer_id($payer_id) { - $this->payer_id = $payer_id; - return $this; - } - /** - * PayPal assigned Payer ID. - * - * @return string - * @deprecated. Instead use getPayerId - */ - public function getPayer_id() { - return $this->payer_id; - } + /** + * Get Last Name + * Last Name of the Payer from their PayPal Account + * + * @return string + */ + public function getLastName() + { + return $this->last_name; + } - /** - * Phone number representing the Payer. - * - * @param string $phone - */ - public function setPhone($phone) { - $this->phone = $phone; - return $this; - } + /** + * Set Last Name + * Last Name of the Payer from their PayPal Account + * + * @param string $last_name + * + * @deprecated Use setLastName + * + * @return $this + */ + public function setLast_name($last_name) + { + $this->last_name = $last_name; - /** - * Phone number representing the Payer. - * - * @return string - */ - public function getPhone() { - return $this->phone; - } + return $this; + } + /** + * Get Last Name + * Last Name of the Payer from their PayPal Account + * + * @deprecated Use getLastName + * + * @return string + */ + public function getLast_name() + { + return $this->last_name; + } - /** - * Shipping address of the Payer from their PayPal Account. - * - * @param PayPal\Api\Address $shipping_address - */ - public function setShippingAddress($shipping_address) { - $this->shipping_address = $shipping_address; - return $this; - } + /** + * Set Payer ID + * PayPal assigned Payer ID + * + * @param string $payer_id + * + * @return $this + */ + public function setPayerId($payer_id) + { + $this->payer_id = $payer_id; - /** - * Shipping address of the Payer from their PayPal Account. - * - * @return PayPal\Api\Address - */ - public function getShippingAddress() { - return $this->shipping_address; - } + return $this; + } - /** - * Shipping address of the Payer from their PayPal Account. - * - * @param PayPal\Api\Address $shipping_address - * @deprecated. Instead use setShippingAddress - */ - 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 - */ - public function getShipping_address() { - return $this->shipping_address; - } + /** + * Get Payer ID + * PayPal assigned Payer ID + * + * @return string + */ + public function getPayerId() + { + return $this->payer_id; + } + /** + * Set Payer ID + * PayPal assigned Payer ID + * + * @param string $payer_id + * + * @deprecated Use setPayerId + * + * @return $this + */ + public function setPayer_id($payer_id) + { + $this->payer_id = $payer_id; + + return $this; + } + + /** + * Get Payer ID + * PayPal assigned Payer ID + * + * @deprecated Use setPayerId + * + * @return string + */ + public function getPayer_id() + { + return $this->payer_id; + } + + /** + * Set Phone + * Phone number representing the Payer + * + * @param string $phone + * + * @return $this + */ + public function setPhone($phone) + { + $this->phone = $phone; + + return $this; + } + + /** + * Get Phone + * Phone number representing the Payer + * + * @return string + */ + public function getPhone() + { + return $this->phone; + } + + /** + * 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) + { + $this->shipping_address = $shipping_address; + + return $this; + } + + /** + * Get Shipping Address + * Shipping address of the Payer from their PayPal Account + * + * @return \PayPal\Api\Address + */ + public function getShippingAddress() + { + return $this->shipping_address; + } + + /** + * 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) + { + $this->shipping_address = $shipping_address; + + return $this; + } + + /** + * Get Shipping Address + * Shipping address of the Payer from their PayPal Account + * + * @deprecated Use getShippingAddress + * + * @return \PayPal\Api\Address + */ + public function getShipping_address() + { + return $this->shipping_address; + } } diff --git a/lib/PayPal/Api/Payment.php b/lib/PayPal/Api/Payment.php index 076ddc5..b601cef 100644 --- a/lib/PayPal/Api/Payment.php +++ b/lib/PayPal/Api/Payment.php @@ -1,4 +1,5 @@ id = $id; - /** - * Identifier of the payment resource created. - * - * @param string $id - */ - public function setId($id) { - $this->id = $id; - return $this; - } + return $this; + } - /** - * Identifier of the payment resource created. - * - * @return string - */ - public function getId() { - return $this->id; - } + /** + * Get ID + * Identifier of the payment resource created + * + * @return string + */ + public function getId() + { + return $this->id; + } + + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @return $this + */ + public function setCreateTime($create_time) + { + $this->create_time = $create_time; + + return $this; + } + + /** + * Get Create Time + * Time the resource was created + * + * @return string + */ + public function getCreateTime() + { + return $this->create_time; + } + + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @deprecated Use setCreateTime + * + * @return $this + */ + public function setCreate_time($create_time) + { + $this->create_time = $create_time; + + return $this; + } + + /** + * Get Create Time + * Time the resource was created + * + * @deprecated Use getCreateTime + * + * @return string + */ + public function getCreate_time() + { + return $this->create_time; + } + + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @return $this + */ + public function setUpdateTime($update_time) + { + $this->update_time = $update_time; + + return $this; + } + + /** + * Get Update Time + * Time the resource was last updated + * + * @return string + */ + public function getUpdateTime() + { + return $this->update_time; + } + + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @deprecated Use setUpdateTime + * + * @return $this + */ + public function setUpdate_time($update_time) + { + $this->update_time = $update_time; + + return $this; + } + + /** + * Get Update Time + * Time the resource was last updated + * + * @deprecated Use getUpdateTime + * + * @return string + */ + public function getUpdate_time() + { + return $this->update_time; + } + + /** + * Set Intent + * Intent of the payment - Sale or Authorization or Order + * + * @param string $intent + * + * @return $this + */ + public function setIntent($intent) + { + $this->intent = $intent; + + return $this; + } + + /** + * Get Intent + * Intent of the payment - Sale or Authorization or Order + * + * @return string + */ + public function getIntent() + { + return $this->intent; + } + + /** + * 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) + { + $this->payer = $payer; + + return $this; + } + + /** + * 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() + { + 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 + * + * @param array|\PayPal\Api\Transaction $transactions + * + * @return $this + */ + 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 + */ + public function getTransactions() + { + return $this->transactions; + } + + /** + * Set State + * State of the payment + * + * @param string $state + * + * @return $this + */ + public function setState($state) + { + $this->state = $state; + + return $this; + } + + /** + * Get State + * State of the payment + * + * @return string + */ + public function getState() + { + return $this->state; + } + + /** + * 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 + * + * @return $this + */ + 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 + */ + public function getLinks() + { + return $this->links; + } - /** - * Time the resource was created. - * - * @param string $create_time - */ - public function setCreateTime($create_time) { - $this->create_time = $create_time; - return $this; - } + /** + * Create + * + * @param \PayPal\Rest\ApiContext|null $apiContext + * + * @return $this + */ + public function create($apiContext = null) + { + $payLoad = $this->toJSON(); - /** - * Time the resource was created. - * - * @return string - */ - public function getCreateTime() { - return $this->create_time; - } + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } - /** - * Time the resource was created. - * - * @param string $create_time - * @deprecated. Instead use setCreateTime - */ - public function setCreate_time($create_time) { - $this->create_time = $create_time; - return $this; - } - /** - * Time the resource was created. - * - * @return string - * @deprecated. Instead use getCreateTime - */ - public function getCreate_time() { - return $this->create_time; - } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/payment", "POST", $payLoad); + $this->fromJson($json); - /** - * Time the resource was last updated. - * - * @param string $update_time - */ - public function setUpdateTime($update_time) { - $this->update_time = $update_time; - return $this; - } + return $this; + } - /** - * Time the resource was last updated. - * - * @return string - */ - public function getUpdateTime() { - return $this->update_time; - } + /** + * 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"); + } - /** - * Time the resource was last updated. - * - * @param string $update_time - * @deprecated. Instead use setUpdateTime - */ - public function setUpdate_time($update_time) { - $this->update_time = $update_time; - return $this; - } - /** - * Time the resource was last updated. - * - * @return string - * @deprecated. Instead use getUpdateTime - */ - public function getUpdate_time() { - return $this->update_time; - } + $payLoad = ""; - /** - * Intent of the payment - Sale or Authorization or Order. - * - * @param string $intent - */ - public function setIntent($intent) { - $this->intent = $intent; - return $this; - } + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } - /** - * Intent of the payment - Sale or Authorization or Order. - * - * @return string - */ - public function getIntent() { - return $this->intent; - } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/payment/$paymentId", "GET", $payLoad); + $ret = new Payment(); + $ret->fromJson($json); - /** - * Source of the funds for this payment represented by a PayPal account or a direct credit card. - * - * @param PayPal\Api\Payer $payer - */ - public function setPayer($payer) { - $this->payer = $payer; - return $this; - } + return $ret; + } - /** - * Source of the funds for this payment represented by a PayPal account or a direct credit card. - * - * @return PayPal\Api\Payer - */ - public function getPayer() { - return $this->payer; - } + /** + * 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"); + } - /** - * 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 - */ - public function setTransactions(array $transactions) { - $this->transactions = $transactions; - return $this; - } + $payLoad = $paymentExecution->toJSON(); - /** - * A payment can have more than one transaction, with each transaction establishing a contract between the payer and a payee - * - * @return PayPal\Api\Transaction - */ - public function getTransactions() { - return $this->transactions; - } + 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); - /** - * state of the payment - * - * @param string $state - */ - public function setState($state) { - $this->state = $state; - return $this; - } + $ret = new Payment(); + $ret->fromJson($json); - /** - * state of the payment - * - * @return string - */ - public function getState() { - return $this->state; - } + return $ret; + } + /** + * 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"); + } - /** - * 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; - } + $payLoad = ""; - /** - * 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; - } + $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, + ); - /** - * 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; - } + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } - /** - * - * - * @array - * @param PayPal\Api\Links $links - */ - public function setLinks($links) { - $this->links = $links; - return $this; - } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/payments/payment?" . http_build_query(array_intersect_key($params, $allowedParams)), "GET", $payLoad); - /** - * - * - * @return PayPal\Api\Links - */ - public function getLinks() { - return $this->links; - } + $ret = new PaymentHistory(); + $ret->fromJson($json); - - - /* - * Creates (and processes) a new Payment Resource. - * - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Payment - */ - 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; - } - - /* - * Obtain the Payment resource for the given identifier. - * - * @param string $paymentId - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Payment - */ - 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; - } - - /* - * Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal. - * - * @param PaymentExecution $paymentExecution - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Payment - */ - 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; - } - - /* - * Retrieves a list of Payment resources. - * - * @param array $params - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return PaymentHistory - */ - 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, ); - 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; - } + return $ret; + } } diff --git a/lib/PayPal/Api/PaymentExecution.php b/lib/PayPal/Api/PaymentExecution.php index 49665c0..a7c7b4f 100644 --- a/lib/PayPal/Api/PaymentExecution.php +++ b/lib/PayPal/Api/PaymentExecution.php @@ -1,68 +1,96 @@ payer_id = $payer_id; - return $this; - } +/** + * Class PaymentExecution + * + * @property string payer_id + * @property \PayPal\Api\Transactions transactions + */ +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; - /** - * PayPal assigned Payer ID returned in the approval return url. - * - * @return string - */ - public function getPayerId() { - return $this->payer_id; - } + return $this; + } - /** - * PayPal assigned Payer ID returned in the approval return url. - * - * @param string $payer_id - * @deprecated. Instead use setPayerId - */ - public function setPayer_id($payer_id) { - $this->payer_id = $payer_id; - return $this; - } - /** - * PayPal assigned Payer ID returned in the approval return url. - * - * @return string - * @deprecated. Instead use getPayerId - */ - public function getPayer_id() { - return $this->payer_id; - } + /** + * Get Payer ID + * PayPal assigned Payer ID returned in the approval return url + * + * @return string + */ + public function getPayerId() + { + 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 - */ - public function setTransactions($transactions) { - $this->transactions = $transactions; - return $this; - } + /** + * Set Payer ID + * PayPal assigned Payer ID returned in the approval return url + * + * @param string $payer_id + * + * @deprecated Use setPayerId + * + * @return $this + */ + public function setPayer_id($payer_id) + { + $this->payer_id = $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. - * - * @return PayPal\Api\Transactions - */ - public function getTransactions() { - return $this->transactions; - } + return $this; + } + /** + * Get Payer ID + * PayPal assigned Payer ID returned in the approval return url + * + * @deprecated Use getPayerId + * + * @return string + */ + public function getPayer_id() + { + return $this->payer_id; + } + /** + * 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) + { + $this->transactions = $transactions; + return $this; + } + + /** + * 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() + { + return $this->transactions; + } } diff --git a/lib/PayPal/Api/PaymentHistory.php b/lib/PayPal/Api/PaymentHistory.php index be1ba24..f18a720 100644 --- a/lib/PayPal/Api/PaymentHistory.php +++ b/lib/PayPal/Api/PaymentHistory.php @@ -1,88 +1,124 @@ payments = $payments; - return $this; - } +/** + * Class PaymentHistory + * + * @property \PayPal\Api\Payment payments + * @property int count + * @property string next_id + */ +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; - /** - * A list of Payment resources - * - * @return PayPal\Api\Payment - */ - public function getPayments() { - return $this->payments; - } + return $this; + } + /** + * Get Payments + * A list of Payment resources + * + * @return \PayPal\Api\Payment + */ + 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 - */ - public function setCount($count) { - $this->count = $count; - return $this; - } + /** + * 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) + { + $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 - */ - public function getCount() { - return $this->count; - } + /** + * 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() + { + return $this->count; + } + /** + * 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) + { + $this->next_id = $next_id; + return $this; + } - /** - * Identifier of the next element to get the next range of results. - * - * @param string $next_id - */ - public function setNextId($next_id) { - $this->next_id = $next_id; - return $this; - } + /** + * Get Next ID + * Identifier of the next element to get the next range of results + * + * @return string + */ + public function getNextId() + { + return $this->next_id; + } - /** - * Identifier of the next element to get the next range of results. - * - * @return string - */ - public function getNextId() { - return $this->next_id; - } - - /** - * Identifier of the next element to get the next range of results. - * - * @param string $next_id - * @deprecated. Instead use setNextId - */ - 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. - * - * @return string - * @deprecated. Instead use getNextId - */ - public function getNext_id() { - return $this->next_id; - } + /** + * Set Next ID + * Identifier of the next element to get the next range of results + * + * @param string $next_id + * + * @deprecated Use setNextId + * + * @return $this + */ + public function setNext_id($next_id) + { + $this->next_id = $next_id; + return $this; + } + + /** + * Get Next ID + * Identifier of the next element to get the next range of results + * + * @deprecated Use getNextId + * + * @return string + */ + public function getNext_id() + { + return $this->next_id; + } } diff --git a/lib/PayPal/Api/RedirectUrls.php b/lib/PayPal/Api/RedirectUrls.php index 42fa970..674f805 100644 --- a/lib/PayPal/Api/RedirectUrls.php +++ b/lib/PayPal/Api/RedirectUrls.php @@ -1,86 +1,127 @@ return_url = $return_url; - return $this; - } +/** + * Class RedirectUrls + * + * @property string return_url + * @property string cancel_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; - /** - * Url where the payer would be redirected to after approving the payment. - * - * @return string - */ - public function getReturnUrl() { - return $this->return_url; - } + return $this; + } - /** - * Url where the payer would be redirected to after approving the payment. - * - * @param string $return_url - * @deprecated. Instead use setReturnUrl - */ - 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. - * - * @return string - * @deprecated. Instead use getReturnUrl - */ - public function getReturn_url() { - return $this->return_url; - } + /** + * Get Return URL + * Url where the payer would be redirected to after approving the payment + * + * @return string + */ + public function getReturnUrl() + { + return $this->return_url; + } - /** - * Url where the payer would be redirected to after canceling the payment. - * - * @param string $cancel_url - */ - public function setCancelUrl($cancel_url) { - $this->cancel_url = $cancel_url; - return $this; - } + /** + * Set Return URL + * Url where the payer would be redirected to after approving the payment + * + * @param string $return_url + * + * @deprecated Use setReturnUrl + * + * @return $this + */ + public function setReturn_url($return_url) + { + $this->return_url = $return_url; - /** - * Url where the payer would be redirected to after canceling the payment. - * - * @return string - */ - public function getCancelUrl() { - return $this->cancel_url; - } + return $this; + } - /** - * Url where the payer would be redirected to after canceling the payment. - * - * @param string $cancel_url - * @deprecated. Instead use setCancelUrl - */ - 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. - * - * @return string - * @deprecated. Instead use getCancelUrl - */ - public function getCancel_url() { - return $this->cancel_url; - } + /** + * Get Return URL + * Url where the payer would be redirected to after approving the payment + * + * @deprecated Use getReturnUrl + * + * @return string + */ + public function getReturn_url() + { + return $this->return_url; + } + /** + * 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) + { + $this->cancel_url = $cancel_url; + + return $this; + } + + /** + * Get Cancel URL + * Url where the payer would be redirected to after canceling the payment + * + * @return string + */ + public function getCancelUrl() + { + return $this->cancel_url; + } + + /** + * Set Cancel URL + * Url where the payer would be redirected to after canceling the payment + * + * @param string $cancel_url + * + * @deprecated Use setCancelUrl + * + * @return $this + */ + public function setCancel_url($cancel_url) + { + $this->cancel_url = $cancel_url; + + return $this; + } + + /** + * Get Cancel URL + * Url where the payer would be redirected to after canceling the payment + * + * @deprecated Use getCancelUrl + * + * @return string + */ + public function getCancel_url() + { + return $this->cancel_url; + } } diff --git a/lib/PayPal/Api/Refund.php b/lib/PayPal/Api/Refund.php index 1239885..41fdb76 100644 --- a/lib/PayPal/Api/Refund.php +++ b/lib/PayPal/Api/Refund.php @@ -1,4 +1,5 @@ id = $id; - /** - * Identifier of the refund transaction. - * - * @param string $id - */ - public function setId($id) { - $this->id = $id; - return $this; - } + return $this; + } - /** - * Identifier of the refund transaction. - * - * @return string - */ - public function getId() { - return $this->id; - } + /** + * Get ID + * Identifier of the refund transaction + * + * @return string + */ + public function getId() + { + return $this->id; + } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @return $this + */ + public function setCreateTime($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was created. - * - * @param string $create_time - */ - public function setCreateTime($create_time) { - $this->create_time = $create_time; - return $this; - } + return $this; + } - /** - * Time the resource was created. - * - * @return string - */ - public function getCreateTime() { - return $this->create_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @return string + */ + public function getCreateTime() + { + return $this->create_time; + } - /** - * Time the resource was created. - * - * @param string $create_time - * @deprecated. Instead use setCreateTime - */ - public function setCreate_time($create_time) { - $this->create_time = $create_time; - return $this; - } - /** - * Time the resource was created. - * - * @return string - * @deprecated. Instead use getCreateTime - */ - public function getCreate_time() { - return $this->create_time; - } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @deprecated Use setCreateTime + * + * @return $this + */ + public function setCreate_time($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was last updated. - * - * @param string $update_time - */ - public function setUpdateTime($update_time) { - $this->update_time = $update_time; - return $this; - } + return $this; + } - /** - * Time the resource was last updated. - * - * @return string - */ - public function getUpdateTime() { - return $this->update_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @deprecated Use getCreateTime + * + * @return string + */ + public function getCreate_time() + { + return $this->create_time; + } - /** - * Time the resource was last updated. - * - * @param string $update_time - * @deprecated. Instead use setUpdateTime - */ - public function setUpdate_time($update_time) { - $this->update_time = $update_time; - return $this; - } - /** - * Time the resource was last updated. - * - * @return string - * @deprecated. Instead use getUpdateTime - */ - public function getUpdate_time() { - return $this->update_time; - } + /** + * 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) + { + $this->amount = $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 - */ - public function setAmount($amount) { - $this->amount = $amount; - return $this; - } + 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 - */ - public function getAmount() { - return $this->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() + { + return $this->amount; + } + /** + * Set State + * State of the refund transaction + * + * @param string $state + * + * @return $this + */ + public function setState($state) + { + $this->state = $state; - /** - * State of the refund transaction. - * - * @param string $state - */ - public function setState($state) { - $this->state = $state; - return $this; - } + return $this; + } - /** - * State of the refund transaction. - * - * @return string - */ - public function getState() { - return $this->state; - } + /** + * Get State + * State of the refund transaction + * + * @return string + */ + public function getState() + { + return $this->state; + } + /** + * Set Sale ID + * ID of the Sale transaction being refunded + * + * @param string $sale_id + * + * @return $this + */ + public function setSaleId($sale_id) + { + $this->sale_id = $sale_id; - /** - * ID of the Sale transaction being refunded. - * - * @param string $sale_id - */ - public function setSaleId($sale_id) { - $this->sale_id = $sale_id; - return $this; - } + return $this; + } - /** - * ID of the Sale transaction being refunded. - * - * @return string - */ - public function getSaleId() { - return $this->sale_id; - } + /** + * Get Sale ID + * 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; - } + /** + * 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; - /** - * ID of the Capture transaction being refunded. - * - * @param string $capture_id - */ - public function setCaptureId($capture_id) { - $this->capture_id = $capture_id; - return $this; - } + return $this; + } - /** - * ID of the Capture transaction being refunded. - * - * @return string - */ - public function getCaptureId() { - return $this->capture_id; - } + /** + * Get Sale ID + * ID of the Sale transaction being refunded + * + * @deprecated Use getSaleId + * + * @return string + */ + public function getSale_id() + { + return $this->sale_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; - } + /** + * 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; - /** - * 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; - } + return $this; + } - /** - * ID of the Payment resource that this transaction is based on. - * - * @return string - */ - public function getParentPayment() { - return $this->parent_payment; - } + /** + * Get Capture ID + * ID of the Capture transaction being refunded + * + * @return string + */ + public function getCaptureId() + { + return $this->capture_id; + } - /** - * 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 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; - /** - * - * - * @array - * @param PayPal\Api\Links $links - */ - public function setLinks($links) { - $this->links = $links; - return $this; - } + return $this; + } - /** - * - * - * @return PayPal\Api\Links - */ - public function getLinks() { - return $this->links; - } + /** + * 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; + } - /* - * Obtain the Refund transaction resource for the given identifier. - * - * @param string $refundId - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Refund - */ - 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; - } + /** + * 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 + */ + public function getLinks() + { + return $this->links; + } + + /** + * 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; + } } diff --git a/lib/PayPal/Api/RelatedResources.php b/lib/PayPal/Api/RelatedResources.php index c10dafc..5dcee4b 100644 --- a/lib/PayPal/Api/RelatedResources.php +++ b/lib/PayPal/Api/RelatedResources.php @@ -1,88 +1,117 @@ sale = $sale; - return $this; - } +/** + * Class RelatedResources + * + * @property \PayPal\Api\Sale sale + * @property \PayPal\Api\Authorization authorization + * @property \PayPal\Api\Capture capture + * @property \PayPal\Api\Refund refund + */ +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; + } - /** - * A sale transaction - * - * @return PayPal\Api\Sale - */ - public function getSale() { - return $this->sale; - } + /** + * Get Sale + * A sale transaction + * + * @return \PayPal\Api\Sale + */ + public function getSale() + { + return $this->sale; + } + /** + * Set Authorization + * An authorization transaction + * + * @param \PayPal\Api\Authorization $authorization + * + * @return $this + */ + public function setAuthorization($authorization) + { + $this->authorization = $authorization; + return $this; + } - /** - * An authorization transaction - * - * @param PayPal\Api\Authorization $authorization - */ - public function setAuthorization($authorization) { - $this->authorization = $authorization; - return $this; - } + /** + * Get Authorization + * An authorization transaction + * + * @return \PayPal\Api\Authorization + */ + public function getAuthorization() + { + return $this->authorization; + } - /** - * An authorization transaction - * - * @return PayPal\Api\Authorization - */ - public function getAuthorization() { - return $this->authorization; - } + /** + * Set Capture + * A capture transaction + * + * @param \PayPal\Api\Capture $capture + * + * @return $this + */ + public function setCapture($capture) + { + $this->capture = $capture; + return $this; + } + /** + * Get Capture + * A capture transaction + * + * @return \PayPal\Api\Capture + */ + public function getCapture() + { + return $this->capture; + } - /** - * A capture transaction - * - * @param PayPal\Api\Capture $capture - */ - public function setCapture($capture) { - $this->capture = $capture; - return $this; - } - - /** - * A capture transaction - * - * @return PayPal\Api\Capture - */ - public function getCapture() { - return $this->capture; - } - - - /** - * A refund transaction - * - * @param PayPal\Api\Refund $refund - */ - public function setRefund($refund) { - $this->refund = $refund; - return $this; - } - - /** - * A refund transaction - * - * @return PayPal\Api\Refund - */ - public function getRefund() { - return $this->refund; - } - + /** + * Set Refund + * A refund transaction + * + * @param \PayPal\Api\Refund $refund + * + * @return $this + */ + public function setRefund($refund) + { + $this->refund = $refund; + return $this; + } + /** + * Get Refund + * A refund transaction + * + * @return \PayPal\Api\Refund + */ + public function getRefund() + { + return $this->refund; + } } diff --git a/lib/PayPal/Api/Sale.php b/lib/PayPal/Api/Sale.php index 2008d20..3a46165 100644 --- a/lib/PayPal/Api/Sale.php +++ b/lib/PayPal/Api/Sale.php @@ -1,4 +1,5 @@ id = $id; - /** - * Identifier of the authorization transaction. - * - * @param string $id - */ - public function setId($id) { - $this->id = $id; - return $this; - } + return $this; + } - /** - * Identifier of the authorization transaction. - * - * @return string - */ - public function getId() { - return $this->id; - } + /** + * Get ID + * Identifier of the authorization transaction + * + * @return string + */ + public function getId() + { + return $this->id; + } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @return $this + */ + public function setCreateTime($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was created. - * - * @param string $create_time - */ - public function setCreateTime($create_time) { - $this->create_time = $create_time; - return $this; - } + return $this; + } - /** - * Time the resource was created. - * - * @return string - */ - public function getCreateTime() { - return $this->create_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @return string + */ + public function getCreateTime() + { + return $this->create_time; + } - /** - * Time the resource was created. - * - * @param string $create_time - * @deprecated. Instead use setCreateTime - */ - public function setCreate_time($create_time) { - $this->create_time = $create_time; - return $this; - } - /** - * Time the resource was created. - * - * @return string - * @deprecated. Instead use getCreateTime - */ - public function getCreate_time() { - return $this->create_time; - } + /** + * Set Create Time + * Time the resource was created + * + * @param string $create_time + * + * @deprecated Use setCreateTime + * + * @return $this + */ + public function setCreate_time($create_time) + { + $this->create_time = $create_time; - /** - * Time the resource was last updated. - * - * @param string $update_time - */ - public function setUpdateTime($update_time) { - $this->update_time = $update_time; - return $this; - } + return $this; + } - /** - * Time the resource was last updated. - * - * @return string - */ - public function getUpdateTime() { - return $this->update_time; - } + /** + * Get Create Time + * Time the resource was created + * + * @deprecated Use getCreateTime + * + * @return string + */ + public function getCreate_time() + { + return $this->create_time; + } - /** - * Time the resource was last updated. - * - * @param string $update_time - * @deprecated. Instead use setUpdateTime - */ - public function setUpdate_time($update_time) { - $this->update_time = $update_time; - return $this; - } - /** - * Time the resource was last updated. - * - * @return string - * @deprecated. Instead use getUpdateTime - */ - public function getUpdate_time() { - return $this->update_time; - } + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @return $this + */ + public function setUpdateTime($update_time) + { + $this->update_time = $update_time; - /** - * Amount being collected. - * - * @param PayPal\Api\Amount $amount - */ - public function setAmount($amount) { - $this->amount = $amount; - return $this; - } + return $this; + } - /** - * Amount being collected. - * - * @return PayPal\Api\Amount - */ - public function getAmount() { - return $this->amount; - } + /** + * Get Update Time + * Time the resource was last updated + * + * @return string + */ + public function getUpdateTime() + { + return $this->update_time; + } + /** + * Set Update Time + * Time the resource was last updated + * + * @param string $update_time + * + * @deprecated Use setUpdateTime + * + * @return $this + */ + public function setUpdate_time($update_time) + { + $this->update_time = $update_time; - /** - * State of the sale transaction. - * - * @param string $state - */ - public function setState($state) { - $this->state = $state; - return $this; - } + return $this; + } - /** - * State of the sale transaction. - * - * @return string - */ - public function getState() { - return $this->state; - } + /** + * Get Update Time + * Time the resource was last updated + * + * @deprecated Use getUpdateTime + * + * @return string + */ + public function getUpdate_time() + { + return $this->update_time; + } + /** + * Set Amount + * Amount being collected + * + * @param \PayPal\Api\Amount $amount + * + * @return $this + */ + public function setAmount($amount) + { + $this->amount = $amount; - /** - * 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; - } + return $this; + } - /** - * ID of the Payment resource that this transaction is based on. - * - * @return string - */ - public function getParentPayment() { - return $this->parent_payment; - } + /** + * Get Amount + * Amount being collected + * + * @return \PayPal\Api\Amount + */ + public function getAmount() + { + return $this->amount; + } - /** - * 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 State + * State of the sale transaction + * + * @param string $state + * + * @return $this + */ + public function setState($state) + { + $this->state = $state; - /** - * - * - * @array - * @param PayPal\Api\Links $links - */ - public function setLinks($links) { - $this->links = $links; - return $this; - } + return $this; + } - /** - * - * - * @return PayPal\Api\Links - */ - public function getLinks() { - return $this->links; - } + /** + * Get State + * State of the sale transaction + * + * @return string + */ + public function getState() + { + return $this->state; + } + /** + * 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; + } - /* - * Obtain the Sale transaction resource for the given identifier. - * - * @param string $saleId - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Sale - */ - 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; - } + /** + * Get Parent Payment + * ID of the Payment resource that this transaction is based on + * + * @return string + */ + public function getParentPayment() + { + return $this->parent_payment; + } - /* - * Creates (and processes) a new Refund Transaction added as a related resource. - * - * @param Refund $refund - * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. - * @return Refund - */ - 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; - } + /** + * 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 + */ + public function getLinks() + { + return $this->links; + } + + /** + * 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; + } + + /** + * 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; + } } diff --git a/lib/PayPal/Api/ShippingAddress.php b/lib/PayPal/Api/ShippingAddress.php index 7bbc1dc..72c1e97 100644 --- a/lib/PayPal/Api/ShippingAddress.php +++ b/lib/PayPal/Api/ShippingAddress.php @@ -1,47 +1,70 @@ recipient_name = $recipient_name; - return $this; - } +/** + * Class ShippingAddress + * + * @property string 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; - /** - * Name of the recipient at this address. - * - * @return string - */ - public function getRecipientName() { - return $this->recipient_name; - } + return $this; + } - /** - * Name of the recipient at this address. - * - * @param string $recipient_name - * @deprecated. Instead use setRecipientName - */ - public function setRecipient_name($recipient_name) { - $this->recipient_name = $recipient_name; - return $this; - } - /** - * Name of the recipient at this address. - * - * @return string - * @deprecated. Instead use getRecipientName - */ - public function getRecipient_name() { - return $this->recipient_name; - } + /** + * Get Recipient Name + * Name of the recipient at this address + * + * @return string + */ + public function getRecipientName() + { + return $this->recipient_name; + } + /** + * Set Recipient Name + * Name of the recipient at this address + * + * @param string $recipient_name + * + * @deprecated Use setRecipientName + * + * @return $this + */ + public function setRecipient_name($recipient_name) + { + $this->recipient_name = $recipient_name; + + return $this; + } + + /** + * Get Recipient Name + * Name of the recipient at this address + * + * @deprecated Use getRecipientName + * + * @return string + */ + public function getRecipient_name() + { + return $this->recipient_name; + } } diff --git a/lib/PayPal/Api/Transaction.php b/lib/PayPal/Api/Transaction.php index 2f4e3b9..4a1be9a 100644 --- a/lib/PayPal/Api/Transaction.php +++ b/lib/PayPal/Api/Transaction.php @@ -1,169 +1,235 @@ amount = $amount; - return $this; - } +/** + * 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 + */ +class Transaction extends PPModel +{ + /** + * Set Amount + * Amount being collected + * + * @param \PayPal\Api\Amount $amount + * + * @return $this + */ + public function setAmount($amount) + { + $this->amount = $amount; - /** - * Amount being collected. - * - * @return PayPal\Api\Amount - */ - public function getAmount() { - return $this->amount; - } + return $this; + } + /** + * Get Amount + * Amount being collected + * + * @return \PayPal\Api\Amount + */ + public function getAmount() + { + return $this->amount; + } - /** - * Recepient of the funds in this transaction. - * - * @param PayPal\Api\Payee $payee - */ - public function setPayee($payee) { - $this->payee = $payee; - return $this; - } + /** + * Set Payee + * Recepient of the funds in this transaction + * + * @param \PayPal\Api\Payee $payee + * + * @return $this + */ + public function setPayee($payee) + { + $this->payee = $payee; - /** - * Recepient of the funds in this transaction. - * - * @return PayPal\Api\Payee - */ - public function getPayee() { - return $this->payee; - } + return $this; + } + /** + * Get Payee + * Recepient of the funds in this transaction + * + * @return \PayPal\Api\Payee + */ + public function getPayee() + { + return $this->payee; + } - /** - * Description of what is being paid for. - * - * @param string $description - */ - public function setDescription($description) { - $this->description = $description; - return $this; - } + /** + * Set Description + * Description of what is being paid for + * + * @param string $description + * + * @return $this + */ + public function setDescription($description) + { + $this->description = $description; - /** - * Description of what is being paid for. - * - * @return string - */ - public function getDescription() { - return $this->description; - } + return $this; + } + /** + * Get Description + * Description of what is being paid for + * + * @return string + */ + public function getDescription() + { + return $this->description; + } - /** - * List of items being paid for. - * - * @param PayPal\Api\ItemList $item_list - */ - public function setItemList($item_list) { - $this->item_list = $item_list; - return $this; - } + /** + * Set Item List + * List of items being paid for + * + * @param \PayPal\Api\ItemList $item_list + * + * @return $this + */ + public function setItemList($item_list) + { + $this->item_list = $item_list; - /** - * List of items being paid for. - * - * @return PayPal\Api\ItemList - */ - public function getItemList() { - return $this->item_list; - } + return $this; + } - /** - * List of items being paid for. - * - * @param PayPal\Api\ItemList $item_list - * @deprecated. Instead use setItemList - */ - 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 - */ - public function getItem_list() { - return $this->item_list; - } + /** + * Get Item List + * List of items being paid for + * + * @return \PayPal\Api\ItemList + */ + public function getItemList() + { + return $this->item_list; + } - /** - * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. - * - * @array - * @param PayPal\Api\RelatedResources $related_resources - */ - public function setRelatedResources($related_resources) { - $this->related_resources = $related_resources; - return $this; - } + /** + * 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) + { + $this->item_list = $item_list; - /** - * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. - * - * @return PayPal\Api\RelatedResources - */ - public function getRelatedResources() { - return $this->related_resources; - } + return $this; + } - /** - * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. - * - * @array - * @param PayPal\Api\RelatedResources $related_resources - * @deprecated. Instead use setRelatedResources - */ - 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 - */ - public function getRelated_resources() { - return $this->related_resources; - } + /** + * Get Item List + * List of items being paid for + * + * @deprecated Use getItemList + * + * @return \PayPal\Api\ItemList + */ + public function getItem_list() + { + return $this->item_list; + } - /** - * Additional transactions for complex payment (Parallel and Chained) scenarios. - * - * @array - * @param PayPal\Api\self $transactions - */ - public function setTransactions($transactions) { - $this->transactions = $transactions; - return $this; - } + /** + * 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) + { + $this->related_resources = $related_resources; - /** - * Additional transactions for complex payment (Parallel and Chained) scenarios. - * - * @return PayPal\Api\self - */ - public function getTransactions() { - return $this->transactions; - } + return $this; + } + /** + * Get Related Resources + * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment + * + * @return \PayPal\Api\RelatedResources + */ + public function getRelatedResources() + { + return $this->related_resources; + } + /** + * 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) + { + $this->related_resources = $related_resources; + + return $this; + } + + /** + * 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() + { + return $this->related_resources; + } + + /** + * Set Transactions + * Additional transactions for complex payment (Parallel and Chained) scenarios + * + * @param \PayPal\Api\self $transactions + * + * @return $this + */ + public function setTransactions($transactions) + { + $this->transactions = $transactions; + + return $this; + } + + /** + * Set Transactions + * Additional transactions for complex payment (Parallel and Chained) scenarios + * + * @return \PayPal\Api\self + */ + public function getTransactions() + { + return $this->transactions; + } } diff --git a/lib/PayPal/Api/Transactions.php b/lib/PayPal/Api/Transactions.php index 5817790..a2aad79 100644 --- a/lib/PayPal/Api/Transactions.php +++ b/lib/PayPal/Api/Transactions.php @@ -1,28 +1,38 @@ amount = $amount; - return $this; - } - - /** - * Amount being collected. - * - * @return PayPal\Api\Amount - */ - public function getAmount() { - return $this->amount; - } +/** + * Class Transactions + * + * @property \PayPal\Api\Amount amount + */ +class Transactions extends PPModel +{ + /** + * Set Amount + * + * @param \PayPal\Api\Amount $amount + * + * @return $this + */ + public function setAmount($amount) + { + $this->amount = $amount; + return $this; + } + /** + * Get Amount + * + * @return \PayPal\Api\Amount + */ + public function getAmount() + { + return $this->amount; + } } diff --git a/lib/PayPal/Auth/OAuthTokenCredential.php b/lib/PayPal/Auth/OAuthTokenCredential.php index 8b4d4e6..36b6dd0 100644 --- a/lib/PayPal/Auth/OAuthTokenCredential.php +++ b/lib/PayPal/Auth/OAuthTokenCredential.php @@ -1,137 +1,180 @@ clientId = $clientId; - $this->clientSecret = $clientSecret; - } - - /** - * @return the accessToken - */ - public function getAccessToken($config) { +/** + * Class OAuthTokenCredential + */ +class OAuthTokenCredential +{ + /** + * Private Variable + * + * @var int $expiryBufferTime + */ + private static $expiryBufferTime = 120; - $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)) { - $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 - */ - private function _generateAccessToken($config) { + /** + * Private Variable + * + * @var \PayPal\Core\PPLoggingManager $logger + */ + private $logger; - $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; - $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 - */ - private function getOAuthHttpConfiguration($config) { - if (isset($config['oauth.EndPoint'])) { - $baseEndpoint = $config['oauth.EndPoint']; - } else if (isset($config['service.EndPoint'])) { - $baseEndpoint = $config['service.EndPoint']; - } else if (isset($config['mode'])) { - switch (strtoupper($config['mode'])) { - case 'SANDBOX': - $baseEndpoint = PPConstants::REST_SANDBOX_ENDPOINT; - break; - case 'LIVE': - $baseEndpoint = PPConstants::REST_LIVE_ENDPOINT; - break; - default: - throw new PPConfigurationException('The mode config parameter must be set to either sandbox/live'); - } - } else { - throw new PPConfigurationException('You must set one of service.endpoint or mode parameters in your configuration'); - } - - $baseEndpoint = rtrim(trim($baseEndpoint), '/'); - return new PPHttpConfig($baseEndpoint . "/v1/oauth2/token", "POST"); - } + /** + * 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) + { + $this->clientId = $clientId; + $this->clientSecret = $clientSecret; + } + + /** + * Get AccessToken + * + * @param $config + * + * @return null|string + */ + 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)) { + $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) + { + $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; + $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) + { + if (isset($config['oauth.EndPoint'])) { + $baseEndpoint = $config['oauth.EndPoint']; + } else if (isset($config['service.EndPoint'])) { + $baseEndpoint = $config['service.EndPoint']; + } else if (isset($config['mode'])) { + switch (strtoupper($config['mode'])) { + case 'SANDBOX': + $baseEndpoint = PPConstants::REST_SANDBOX_ENDPOINT; + break; + case 'LIVE': + $baseEndpoint = PPConstants::REST_LIVE_ENDPOINT; + break; + default: + throw new PPConfigurationException('The mode config parameter must be set to either sandbox/live'); + } + } else { + throw new PPConfigurationException('You must set one of service.endpoint or mode parameters in your configuration'); + } + + $baseEndpoint = rtrim(trim($baseEndpoint), '/'); + + return new PPHttpConfig($baseEndpoint . "/v1/oauth2/token", "POST"); + } } diff --git a/lib/PayPal/Rest/ApiContext.php b/lib/PayPal/Rest/ApiContext.php index a485897..5097f6f 100644 --- a/lib/PayPal/Rest/ApiContext.php +++ b/lib/PayPal/Rest/ApiContext.php @@ -1,75 +1,93 @@ credential; - } - - public function getrequestId() { - if($this->requestId == null) { - $this->requestId = $this->generateRequestId(); - } - return $this->requestId; - } - - - /** - * - * @param PayPal/Api/OAuthTokenCredential $credential - * @param string $requestId - */ - public function __construct($credential, $requestId=null) { - $this->credential = $credential; - $this->requestId = $requestId; - } - - /** - * 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() { - - static $pid = -1; - static $addr = -1; - - if ($pid == -1) { - $pid = getmypid(); - } - if ($addr == -1) { - if(array_key_exists('SERVER_ADDR', $_SERVER)) { - $addr = ip2long($_SERVER['SERVER_ADDR']); - } else { - $addr = php_uname('n'); - } - } - - return $addr . $pid . $_SERVER['REQUEST_TIME'] . mt_rand(0, 0xffff); - } +class ApiContext extends PPApiContext +{ + /** + * OAuth Credentials to use for this call + * + * @var \PayPal\Auth\OAuthTokenCredential $credential + */ + private $credential; + + /** + * 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 null|string $requestId + */ + private $requestId; + + /** + * Get Credential + * + * @return \PayPal\Auth\OAuthTokenCredential + */ + public function getCredential() + { + return $this->credential; + } + + /** + * Get Request ID + * + * @return string + */ + public function getrequestId() + { + if ($this->requestId == null) { + $this->requestId = $this->generateRequestId(); + } + + return $this->requestId; + } + + /** + * Construct + * + * @param \PayPal\Auth\OAuthTokenCredential $credential + * @param string|null $requestId + */ + public function __construct($credential, $requestId = null) + { + $this->credential = $credential; + $this->requestId = $requestId; + } + + /** + * 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() + { + static $pid = -1; + static $addr = -1; + + if ($pid == -1) { + $pid = getmypid(); + } + + if ($addr == -1) { + if (array_key_exists('SERVER_ADDR', $_SERVER)) { + $addr = ip2long($_SERVER['SERVER_ADDR']); + } else { + $addr = php_uname('n'); + } + } + + return $addr . $pid . $_SERVER['REQUEST_TIME'] . mt_rand(0, 0xffff); + } } diff --git a/lib/PayPal/Rest/IResource.php b/lib/PayPal/Rest/IResource.php index 395586c..0f762f0 100644 --- a/lib/PayPal/Rest/IResource.php +++ b/lib/PayPal/Rest/IResource.php @@ -2,6 +2,9 @@ namespace PayPal\Rest; -interface IResource { - -} \ No newline at end of file +/** + * Interface IResource + */ +interface IResource +{ +} diff --git a/lib/PayPal/Rest/RestHandler.php b/lib/PayPal/Rest/RestHandler.php index cbdd2fa..9331d6e 100644 --- a/lib/PayPal/Rest/RestHandler.php +++ b/lib/PayPal/Rest/RestHandler.php @@ -1,84 +1,131 @@ apiContext = $apiContext; - } - - public function handle($httpConfig, $request, $options) { - - $credential = $this->apiContext->getCredential(); - $config = $this->apiContext->getConfig(); - - if($credential == NULL) { - // Try picking credentials from the config file - $credMgr = PPCredentialManager::getInstance($config); - $credValues = $credMgr->getCredentialObject(); - 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) ) { - throw new PPInvalidCredentialException("Invalid credentials passed"); - } + /** + * Public Variable + * + * @var string $sdkName + */ + public static $sdkName = "rest-sdk-php"; - - $httpConfig->setUrl( - rtrim( trim($this->_getEndpoint($config)), '/') . - (isset($options['path']) ? $options['path'] : '') - ); - - 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) { - $httpConfig->addHeader('Authorization', "Bearer " . $credential->getAccessToken($config)); - } - if($httpConfig->getMethod() == 'POST' || $httpConfig->getMethod() == 'PUT') { - $httpConfig->addHeader('PayPal-Request-Id', $this->apiContext->getRequestId()); - } - - } - - private function _getEndpoint($config) { - if (isset($config['service.EndPoint'])) { - return $config['service.EndPoint']; - } else if (isset($config['mode'])) { - switch (strtoupper($config['mode'])) { - case 'SANDBOX': - return PPConstants::REST_SANDBOX_ENDPOINT; - break; - case 'LIVE': - return PPConstants::REST_LIVE_ENDPOINT; - break; - default: - throw new PPConfigurationException('The mode config parameter must be set to either sandbox/live'); - break; - } - } else { - throw new PPConfigurationException('You must set one of service.endpoint or mode parameters in your configuration'); - } - } + /** + * Public Variable + * + * @var string $sdkVersion + */ + public static $sdkVersion = "0.6.0"; + /** + * Construct + * + * @param \Paypal\Rest\ApiContext $apiContext + */ + public function __construct($apiContext) + { + $this->apiContext = $apiContext; + } + + /** + * 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) { + // Try picking credentials from the config file + $credMgr = PPCredentialManager::getInstance($config); + $credValues = $credMgr->getCredentialObject(); + + 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)) { + throw new PPInvalidCredentialException("Invalid credentials passed"); + } + + $httpConfig->setUrl( + rtrim(trim($this->_getEndpoint($config)), '/') . + (isset($options['path']) ? $options['path'] : '') + ); + + 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) { + $httpConfig->addHeader('Authorization', "Bearer " . $credential->getAccessToken($config)); + } + + if ($httpConfig->getMethod() == 'POST' || $httpConfig->getMethod() == 'PUT') { + $httpConfig->addHeader('PayPal-Request-Id', $this->apiContext->getRequestId()); + } + } + + /** + * 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'])) { + switch (strtoupper($config['mode'])) { + case 'SANDBOX': + return PPConstants::REST_SANDBOX_ENDPOINT; + break; + case 'LIVE': + return PPConstants::REST_LIVE_ENDPOINT; + break; + default: + throw new PPConfigurationException('The mode config parameter must be set to either sandbox/live'); + break; + } + } else { + throw new PPConfigurationException('You must set one of service.endpoint or mode parameters in your configuration'); + } + } }