diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 0c6c6f21..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,24 +0,0 @@ -CHANGELOG -========= - -V0.7.1 (July 31, 2013) ------------------------ - * Added support for Reauthorization - -V0.7.0 (May 30, 2013) ------------------------ - - * Added support for Auth and Capture APIs - * Types modified to match the API Spec - * Updated SDK to use namespace supported core library - -V0.6.0 (April 26, 2013) ------------------------ - - * Adding support for dynamic configuration of SDK (Upgrading sdk-core-php dependency to V1.4.0) - * Deprecating the setCredential method and changing resource class methods to take an ApiContext argument instead of a OauthTokenCredential argument. - -V0.5.0 (March 07, 2013) ------------------------ - - * Initial Release diff --git a/lib/PayPal/Api/Address.php b/lib/PayPal/Api/Address.php index fa9300e5..a5191c95 100644 --- a/lib/PayPal/Api/Address.php +++ b/lib/PayPal/Api/Address.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Address extends PPModel { /** * Line 1 of the Address (eg. number, street, etc). + * * @param string $line1 */ public function setLine1($line1) { @@ -15,6 +17,7 @@ public function setLine1($line1) { /** * Line 1 of the Address (eg. number, street, etc). + * * @return string */ public function getLine1() { @@ -24,6 +27,7 @@ public function getLine1() { /** * Optional line 2 of the Address (eg. suite, apt #, etc.). + * * @param string $line2 */ public function setLine2($line2) { @@ -33,6 +37,7 @@ public function setLine2($line2) { /** * Optional line 2 of the Address (eg. suite, apt #, etc.). + * * @return string */ public function getLine2() { @@ -42,6 +47,7 @@ public function getLine2() { /** * City name. + * * @param string $city */ public function setCity($city) { @@ -51,6 +57,7 @@ public function setCity($city) { /** * City name. + * * @return string */ public function getCity() { @@ -60,6 +67,7 @@ public function getCity() { /** * 2 letter country code. + * * @param string $country_code */ public function setCountryCode($country_code) { @@ -69,6 +77,7 @@ public function setCountryCode($country_code) { /** * 2 letter country code. + * * @return string */ public function getCountryCode() { @@ -77,6 +86,7 @@ public function getCountryCode() { /** * 2 letter country code. + * * @param string $country_code * @deprecated. Instead use setCountryCode */ @@ -86,6 +96,7 @@ public function setCountry_code($country_code) { } /** * 2 letter country code. + * * @return string * @deprecated. Instead use getCountryCode */ @@ -95,6 +106,7 @@ public function getCountry_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) { @@ -104,6 +116,7 @@ public function setPostalCode($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() { @@ -112,6 +125,7 @@ public function getPostalCode() { /** * 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 */ @@ -121,6 +135,7 @@ public function setPostal_code($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 * @deprecated. Instead use getPostalCode */ @@ -130,6 +145,7 @@ public function getPostal_code() { /** * 2 letter code for US states, and the equivalent for other countries. + * * @param string $state */ public function setState($state) { @@ -139,6 +155,7 @@ public function setState($state) { /** * 2 letter code for US states, and the equivalent for other countries. + * * @return string */ public function getState() { @@ -148,6 +165,7 @@ public function getState() { /** * Phone number in E.123 format. + * * @param string $phone */ public function setPhone($phone) { @@ -157,6 +175,7 @@ public function setPhone($phone) { /** * Phone number in E.123 format. + * * @return string */ public function getPhone() { diff --git a/lib/PayPal/Api/Amount.php b/lib/PayPal/Api/Amount.php index 8c7cfe29..d03ed2e9 100644 --- a/lib/PayPal/Api/Amount.php +++ b/lib/PayPal/Api/Amount.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Amount extends PPModel { /** * 3 letter currency code + * * @param string $currency */ public function setCurrency($currency) { @@ -15,6 +17,7 @@ public function setCurrency($currency) { /** * 3 letter currency code + * * @return string */ public function getCurrency() { @@ -24,6 +27,7 @@ public function getCurrency() { /** * 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) { @@ -33,6 +37,7 @@ public function setTotal($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() { @@ -42,6 +47,7 @@ public function getTotal() { /** * Additional details of the payment amount. + * * @param PayPal\Api\Details $details */ public function setDetails($details) { @@ -51,6 +57,7 @@ public function setDetails($details) { /** * Additional details of the payment amount. + * * @return PayPal\Api\Details */ public function getDetails() { diff --git a/lib/PayPal/Api/Authorization.php b/lib/PayPal/Api/Authorization.php index 9fc4b6dd..0e5a6484 100644 --- a/lib/PayPal/Api/Authorization.php +++ b/lib/PayPal/Api/Authorization.php @@ -2,10 +2,8 @@ namespace PayPal\Api; use PayPal\Common\PPModel; -use PayPal\Rest\IResource; -use PayPal\Rest\Call; use PayPal\Rest\ApiContext; -use PayPal\Api\Authorization; +use PayPal\Rest\IResource; use PayPal\Api\Capture; use PayPal\Transport\PPRestCall; @@ -23,6 +21,7 @@ public static function setCredential($credential) { /** * Identifier of the authorization transaction. + * * @param string $id */ public function setId($id) { @@ -32,6 +31,7 @@ public function setId($id) { /** * Identifier of the authorization transaction. + * * @return string */ public function getId() { @@ -41,6 +41,7 @@ public function getId() { /** * Time the resource was created. + * * @param string $create_time */ public function setCreateTime($create_time) { @@ -50,6 +51,7 @@ public function setCreateTime($create_time) { /** * Time the resource was created. + * * @return string */ public function getCreateTime() { @@ -58,6 +60,7 @@ public function getCreateTime() { /** * Time the resource was created. + * * @param string $create_time * @deprecated. Instead use setCreateTime */ @@ -67,6 +70,7 @@ public function setCreate_time($create_time) { } /** * Time the resource was created. + * * @return string * @deprecated. Instead use getCreateTime */ @@ -76,6 +80,7 @@ public function getCreate_time() { /** * Time the resource was last updated. + * * @param string $update_time */ public function setUpdateTime($update_time) { @@ -85,6 +90,7 @@ public function setUpdateTime($update_time) { /** * Time the resource was last updated. + * * @return string */ public function getUpdateTime() { @@ -93,6 +99,7 @@ public function getUpdateTime() { /** * Time the resource was last updated. + * * @param string $update_time * @deprecated. Instead use setUpdateTime */ @@ -102,6 +109,7 @@ public function setUpdate_time($update_time) { } /** * Time the resource was last updated. + * * @return string * @deprecated. Instead use getUpdateTime */ @@ -111,6 +119,7 @@ public function getUpdate_time() { /** * Amount being authorized for. + * * @param PayPal\Api\Amount $amount */ public function setAmount($amount) { @@ -120,6 +129,7 @@ public function setAmount($amount) { /** * Amount being authorized for. + * * @return PayPal\Api\Amount */ public function getAmount() { @@ -129,6 +139,7 @@ public function getAmount() { /** * State of the authorization transaction. + * * @param string $state */ public function setState($state) { @@ -138,6 +149,7 @@ public function setState($state) { /** * State of the authorization transaction. + * * @return string */ public function getState() { @@ -147,6 +159,7 @@ public function getState() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment */ public function setParentPayment($parent_payment) { @@ -156,6 +169,7 @@ public function setParentPayment($parent_payment) { /** * ID of the Payment resource that this transaction is based on. + * * @return string */ public function getParentPayment() { @@ -164,6 +178,7 @@ public function getParentPayment() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment * @deprecated. Instead use setParentPayment */ @@ -173,6 +188,7 @@ public function setParent_payment($parent_payment) { } /** * ID of the Payment resource that this transaction is based on. + * * @return string * @deprecated. Instead use getParentPayment */ @@ -182,6 +198,7 @@ public function getParent_payment() { /** * Date/Time until which funds may be captured against this resource. + * * @param string $valid_until */ public function setValidUntil($valid_until) { @@ -191,6 +208,7 @@ public function setValidUntil($valid_until) { /** * Date/Time until which funds may be captured against this resource. + * * @return string */ public function getValidUntil() { @@ -199,6 +217,7 @@ public function getValidUntil() { /** * Date/Time until which funds may be captured against this resource. + * * @param string $valid_until * @deprecated. Instead use setValidUntil */ @@ -208,6 +227,7 @@ public function setValid_until($valid_until) { } /** * Date/Time until which funds may be captured against this resource. + * * @return string * @deprecated. Instead use getValidUntil */ @@ -217,6 +237,7 @@ public function getValid_until() { /** * + * * @array * @param PayPal\Api\Links $links */ @@ -227,6 +248,7 @@ public function setLinks($links) { /** * + * * @return PayPal\Api\Links */ public function getLinks() { @@ -235,6 +257,13 @@ public function getLinks() { + /* + * 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"); @@ -250,6 +279,13 @@ public static function get($authorizationId, $apiContext = null) { return $ret; } + /* + * 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"); @@ -268,6 +304,12 @@ public function capture($capture, $apiContext = null) { return $ret; } + /* + * 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"); @@ -283,6 +325,12 @@ public function void($apiContext = null) { return $ret; } + /* + * 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"); diff --git a/lib/PayPal/Api/BillingInfo.php b/lib/PayPal/Api/BillingInfo.php new file mode 100644 index 00000000..86e6ef6a --- /dev/null +++ b/lib/PayPal/Api/BillingInfo.php @@ -0,0 +1,224 @@ +email = $email; + return $this; + } + + /** + * Email address of the invoice recipient. 260 characters max. + * + * @return string + */ + public function getEmail() { + return $this->email; + } + + + /** + * First name of the invoice recipient. 30 characters max. + * + * @param string $first_name + */ + public function setFirstName($first_name) { + $this->first_name = $first_name; + return $this; + } + + /** + * First name of the invoice recipient. 30 characters max. + * + * @return string + */ + public function getFirstName() { + return $this->first_name; + } + + /** + * First name of the invoice recipient. 30 characters max. + * + * @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 invoice recipient. 30 characters max. + * + * @return string + * @deprecated. Instead use getFirstName + */ + public function getFirst_name() { + return $this->first_name; + } + + /** + * Last name of the invoice recipient. 30 characters max. + * + * @param string $last_name + */ + public function setLastName($last_name) { + $this->last_name = $last_name; + return $this; + } + + /** + * Last name of the invoice recipient. 30 characters max. + * + * @return string + */ + public function getLastName() { + return $this->last_name; + } + + /** + * Last name of the invoice recipient. 30 characters max. + * + * @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 invoice recipient. 30 characters max. + * + * @return string + * @deprecated. Instead use getLastName + */ + public function getLast_name() { + return $this->last_name; + } + + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @param string $business_name + */ + public function setBusinessName($business_name) { + $this->business_name = $business_name; + return $this; + } + + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @return string + */ + public function getBusinessName() { + return $this->business_name; + } + + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @param string $business_name + * @deprecated. Instead use setBusinessName + */ + public function setBusiness_name($business_name) { + $this->business_name = $business_name; + return $this; + } + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @return string + * @deprecated. Instead use getBusinessName + */ + public function getBusiness_name() { + return $this->business_name; + } + + /** + * Address of the invoice recipient. + * + * @param PayPal\Api\Address $address + */ + public function setAddress($address) { + $this->address = $address; + return $this; + } + + /** + * Address of the invoice recipient. + * + * @return PayPal\Api\Address + */ + public function getAddress() { + return $this->address; + } + + + /** + * Language of the email sent to the payer. Will only be used if payer doesn't have a PayPal account. + * + * @param string $language + */ + public function setLanguage($language) { + $this->language = $language; + return $this; + } + + /** + * Language of the email sent to the payer. Will only be used if payer doesn't have a PayPal account. + * + * @return string + */ + public function getLanguage() { + return $this->language; + } + + + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @param string $additional_info + */ + public function setAdditionalInfo($additional_info) { + $this->additional_info = $additional_info; + return $this; + } + + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @return string + */ + public function getAdditionalInfo() { + return $this->additional_info; + } + + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @param string $additional_info + * @deprecated. Instead use setAdditionalInfo + */ + public function setAdditional_info($additional_info) { + $this->additional_info = $additional_info; + return $this; + } + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @return string + * @deprecated. Instead use getAdditionalInfo + */ + public function getAdditional_info() { + return $this->additional_info; + } + +} diff --git a/lib/PayPal/Api/CancelNotification.php b/lib/PayPal/Api/CancelNotification.php new file mode 100644 index 00000000..c41d5b68 --- /dev/null +++ b/lib/PayPal/Api/CancelNotification.php @@ -0,0 +1,126 @@ +subject = $subject; + return $this; + } + + /** + * Subject of the notification. + * + * @return string + */ + public function getSubject() { + return $this->subject; + } + + + /** + * Note to the payer. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Note to the payer. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @param boolean $send_to_merchant + */ + public function setSendToMerchant($send_to_merchant) { + $this->send_to_merchant = $send_to_merchant; + return $this; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @return boolean + */ + public function getSendToMerchant() { + return $this->send_to_merchant; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @param boolean $send_to_merchant + * @deprecated. Instead use setSendToMerchant + */ + public function setSend_to_merchant($send_to_merchant) { + $this->send_to_merchant = $send_to_merchant; + return $this; + } + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @return boolean + * @deprecated. Instead use getSendToMerchant + */ + public function getSend_to_merchant() { + return $this->send_to_merchant; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the payer. + * + * @param boolean $send_to_payer + */ + public function setSendToPayer($send_to_payer) { + $this->send_to_payer = $send_to_payer; + return $this; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the payer. + * + * @return boolean + */ + public function getSendToPayer() { + return $this->send_to_payer; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the payer. + * + * @param boolean $send_to_payer + * @deprecated. Instead use setSendToPayer + */ + public function setSend_to_payer($send_to_payer) { + $this->send_to_payer = $send_to_payer; + return $this; + } + /** + * A flag indicating whether a copy of the email has to be sent to the payer. + * + * @return boolean + * @deprecated. Instead use getSendToPayer + */ + public function getSend_to_payer() { + return $this->send_to_payer; + } + +} diff --git a/lib/PayPal/Api/Capture.php b/lib/PayPal/Api/Capture.php index 773f9526..06e91a46 100644 --- a/lib/PayPal/Api/Capture.php +++ b/lib/PayPal/Api/Capture.php @@ -2,10 +2,8 @@ namespace PayPal\Api; use PayPal\Common\PPModel; -use PayPal\Rest\IResource; -use PayPal\Rest\Call; use PayPal\Rest\ApiContext; -use PayPal\Api\Capture; +use PayPal\Rest\IResource; use PayPal\Api\Refund; use PayPal\Transport\PPRestCall; @@ -23,6 +21,7 @@ public static function setCredential($credential) { /** * Identifier of the Capture transaction. + * * @param string $id */ public function setId($id) { @@ -32,6 +31,7 @@ public function setId($id) { /** * Identifier of the Capture transaction. + * * @return string */ public function getId() { @@ -41,6 +41,7 @@ public function getId() { /** * Time the resource was created. + * * @param string $create_time */ public function setCreateTime($create_time) { @@ -50,6 +51,7 @@ public function setCreateTime($create_time) { /** * Time the resource was created. + * * @return string */ public function getCreateTime() { @@ -58,6 +60,7 @@ public function getCreateTime() { /** * Time the resource was created. + * * @param string $create_time * @deprecated. Instead use setCreateTime */ @@ -67,6 +70,7 @@ public function setCreate_time($create_time) { } /** * Time the resource was created. + * * @return string * @deprecated. Instead use getCreateTime */ @@ -76,6 +80,7 @@ public function getCreate_time() { /** * Time the resource was last updated. + * * @param string $update_time */ public function setUpdateTime($update_time) { @@ -85,6 +90,7 @@ public function setUpdateTime($update_time) { /** * Time the resource was last updated. + * * @return string */ public function getUpdateTime() { @@ -93,6 +99,7 @@ public function getUpdateTime() { /** * Time the resource was last updated. + * * @param string $update_time * @deprecated. Instead use setUpdateTime */ @@ -102,6 +109,7 @@ public function setUpdate_time($update_time) { } /** * Time the resource was last updated. + * * @return string * @deprecated. Instead use getUpdateTime */ @@ -111,6 +119,7 @@ public function getUpdate_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) { @@ -120,6 +129,7 @@ public function setAmount($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() { @@ -129,6 +139,7 @@ public function getAmount() { /** * 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) { @@ -138,6 +149,7 @@ public function setIsFinalCapture($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() { @@ -146,6 +158,7 @@ public function getIsFinalCapture() { /** * 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 */ @@ -155,6 +168,7 @@ public function setIs_final_capture($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 * @deprecated. Instead use getIsFinalCapture */ @@ -164,6 +178,7 @@ public function getIs_final_capture() { /** * State of the capture transaction. + * * @param string $state */ public function setState($state) { @@ -173,6 +188,7 @@ public function setState($state) { /** * State of the capture transaction. + * * @return string */ public function getState() { @@ -182,6 +198,7 @@ public function getState() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment */ public function setParentPayment($parent_payment) { @@ -191,6 +208,7 @@ public function setParentPayment($parent_payment) { /** * ID of the Payment resource that this transaction is based on. + * * @return string */ public function getParentPayment() { @@ -199,6 +217,7 @@ public function getParentPayment() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment * @deprecated. Instead use setParentPayment */ @@ -208,6 +227,7 @@ public function setParent_payment($parent_payment) { } /** * ID of the Payment resource that this transaction is based on. + * * @return string * @deprecated. Instead use getParentPayment */ @@ -217,6 +237,7 @@ public function getParent_payment() { /** * + * * @array * @param PayPal\Api\Links $links */ @@ -227,6 +248,7 @@ public function setLinks($links) { /** * + * * @return PayPal\Api\Links */ public function getLinks() { @@ -235,6 +257,13 @@ public function getLinks() { + /* + * 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"); @@ -250,6 +279,13 @@ public static function get($captureId, $apiContext = null) { return $ret; } + /* + * 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"); diff --git a/lib/PayPal/Api/Cost.php b/lib/PayPal/Api/Cost.php new file mode 100644 index 00000000..694c3659 --- /dev/null +++ b/lib/PayPal/Api/Cost.php @@ -0,0 +1,48 @@ +percent = $percent; + return $this; + } + + /** + * Cost in percent. Range of 0 to 100. + * + * @return PayPal\Api\number + */ + public function getPercent() { + return $this->percent; + } + + + /** + * Cost in amount. Range of 0 to 999999.99. + * + * @param PayPal\Api\Currency $amount + */ + public function setAmount($amount) { + $this->amount = $amount; + return $this; + } + + /** + * Cost in amount. Range of 0 to 999999.99. + * + * @return PayPal\Api\Currency + */ + public function getAmount() { + return $this->amount; + } + + +} diff --git a/lib/PayPal/Api/CreditCard.php b/lib/PayPal/Api/CreditCard.php index cd0ee91c..0994e47f 100644 --- a/lib/PayPal/Api/CreditCard.php +++ b/lib/PayPal/Api/CreditCard.php @@ -2,10 +2,9 @@ namespace PayPal\Api; use PayPal\Common\PPModel; -use PayPal\Rest\IResource; -use PayPal\Rest\Call; use PayPal\Rest\ApiContext; -use PayPal\Api\CreditCard; +use PayPal\Rest\IResource; +use PayPal\Api\CreditCardHistory; use PayPal\Transport\PPRestCall; class CreditCard extends PPModel implements IResource { @@ -22,6 +21,7 @@ public static function setCredential($credential) { /** * ID of the credit card being saved for later use. + * * @param string $id */ public function setId($id) { @@ -31,6 +31,7 @@ public function setId($id) { /** * ID of the credit card being saved for later use. + * * @return string */ public function getId() { @@ -40,6 +41,7 @@ public function getId() { /** * Card number. + * * @param string $number */ public function setNumber($number) { @@ -49,6 +51,7 @@ public function setNumber($number) { /** * Card number. + * * @return string */ public function getNumber() { @@ -58,6 +61,7 @@ public function getNumber() { /** * Type of the Card (eg. Visa, Mastercard, etc.). + * * @param string $type */ public function setType($type) { @@ -67,6 +71,7 @@ public function setType($type) { /** * Type of the Card (eg. Visa, Mastercard, etc.). + * * @return string */ public function getType() { @@ -76,6 +81,7 @@ public function getType() { /** * card expiry month with value 1 - 12. + * * @param integer $expire_month */ public function setExpireMonth($expire_month) { @@ -85,6 +91,7 @@ public function setExpireMonth($expire_month) { /** * card expiry month with value 1 - 12. + * * @return integer */ public function getExpireMonth() { @@ -93,6 +100,7 @@ public function getExpireMonth() { /** * card expiry month with value 1 - 12. + * * @param integer $expire_month * @deprecated. Instead use setExpireMonth */ @@ -102,6 +110,7 @@ public function setExpire_month($expire_month) { } /** * card expiry month with value 1 - 12. + * * @return integer * @deprecated. Instead use getExpireMonth */ @@ -111,6 +120,7 @@ public function getExpire_month() { /** * 4 digit card expiry year + * * @param integer $expire_year */ public function setExpireYear($expire_year) { @@ -120,6 +130,7 @@ public function setExpireYear($expire_year) { /** * 4 digit card expiry year + * * @return integer */ public function getExpireYear() { @@ -128,6 +139,7 @@ public function getExpireYear() { /** * 4 digit card expiry year + * * @param integer $expire_year * @deprecated. Instead use setExpireYear */ @@ -137,6 +149,7 @@ public function setExpire_year($expire_year) { } /** * 4 digit card expiry year + * * @return integer * @deprecated. Instead use getExpireYear */ @@ -146,6 +159,7 @@ public function getExpire_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) { @@ -155,6 +169,7 @@ public function setCvv2($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() { @@ -164,6 +179,7 @@ public function getCvv2() { /** * Card holder's first name. + * * @param string $first_name */ public function setFirstName($first_name) { @@ -173,6 +189,7 @@ public function setFirstName($first_name) { /** * Card holder's first name. + * * @return string */ public function getFirstName() { @@ -181,6 +198,7 @@ public function getFirstName() { /** * Card holder's first name. + * * @param string $first_name * @deprecated. Instead use setFirstName */ @@ -190,6 +208,7 @@ public function setFirst_name($first_name) { } /** * Card holder's first name. + * * @return string * @deprecated. Instead use getFirstName */ @@ -199,6 +218,7 @@ public function getFirst_name() { /** * Card holder's last name. + * * @param string $last_name */ public function setLastName($last_name) { @@ -208,6 +228,7 @@ public function setLastName($last_name) { /** * Card holder's last name. + * * @return string */ public function getLastName() { @@ -216,6 +237,7 @@ public function getLastName() { /** * Card holder's last name. + * * @param string $last_name * @deprecated. Instead use setLastName */ @@ -225,6 +247,7 @@ public function setLast_name($last_name) { } /** * Card holder's last name. + * * @return string * @deprecated. Instead use getLastName */ @@ -234,6 +257,7 @@ public function getLast_name() { /** * Billing Address associated with this card. + * * @param PayPal\Api\Address $billing_address */ public function setBillingAddress($billing_address) { @@ -243,6 +267,7 @@ public function setBillingAddress($billing_address) { /** * Billing Address associated with this card. + * * @return PayPal\Api\Address */ public function getBillingAddress() { @@ -251,6 +276,7 @@ public function getBillingAddress() { /** * Billing Address associated with this card. + * * @param PayPal\Api\Address $billing_address * @deprecated. Instead use setBillingAddress */ @@ -260,6 +286,7 @@ public function setBilling_address($billing_address) { } /** * Billing Address associated with this card. + * * @return PayPal\Api\Address * @deprecated. Instead use getBillingAddress */ @@ -269,6 +296,7 @@ public function getBilling_address() { /** * 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) { @@ -278,6 +306,7 @@ public function setPayerId($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() { @@ -286,6 +315,7 @@ public function getPayerId() { /** * 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 */ @@ -295,6 +325,7 @@ public function setPayer_id($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 * @deprecated. Instead use getPayerId */ @@ -304,6 +335,7 @@ public function getPayer_id() { /** * State of the funding instrument. + * * @param string $state */ public function setState($state) { @@ -313,6 +345,7 @@ public function setState($state) { /** * State of the funding instrument. + * * @return string */ public function getState() { @@ -322,6 +355,7 @@ public function getState() { /** * Date/Time until this resource can be used fund a payment. + * * @param string $valid_until */ public function setValidUntil($valid_until) { @@ -331,6 +365,7 @@ public function setValidUntil($valid_until) { /** * Date/Time until this resource can be used fund a payment. + * * @return string */ public function getValidUntil() { @@ -339,6 +374,7 @@ public function getValidUntil() { /** * Date/Time until this resource can be used fund a payment. + * * @param string $valid_until * @deprecated. Instead use setValidUntil */ @@ -348,6 +384,7 @@ public function setValid_until($valid_until) { } /** * Date/Time until this resource can be used fund a payment. + * * @return string * @deprecated. Instead use getValidUntil */ @@ -357,6 +394,7 @@ public function getValid_until() { /** * + * * @array * @param PayPal\Api\Links $links */ @@ -367,6 +405,7 @@ public function setLinks($links) { /** * + * * @return PayPal\Api\Links */ public function getLinks() { @@ -375,6 +414,12 @@ public function getLinks() { + /* + * 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) { @@ -386,6 +431,13 @@ public function create($apiContext = null) { return $this; } + /* + * 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"); @@ -401,6 +453,12 @@ public static function get($creditCardId, $apiContext = null) { return $ret; } + /* + * 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"); @@ -413,4 +471,42 @@ public function delete($apiContext = null) { $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/vault/credit-card/{$this->getId()}", "DELETE", $payLoad); return true; } + + /* + * 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; + } + + /* + * 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; + } } diff --git a/lib/PayPal/Api/CreditCardHistory.php b/lib/PayPal/Api/CreditCardHistory.php index 4251e62f..ece20ee7 100644 --- a/lib/PayPal/Api/CreditCardHistory.php +++ b/lib/PayPal/Api/CreditCardHistory.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class CreditCardHistory extends PPModel { /** * A list of credit card resources + * * @array * @param PayPal\Api\CreditCard $credit-cards */ @@ -16,6 +18,7 @@ public function setCreditCards($credit_cards) { /** * A list of credit card resources + * * @return PayPal\Api\CreditCard */ public function getCreditCards() { @@ -24,6 +27,7 @@ public function getCreditCards() { /** * A list of credit card resources + * * @array * @param PayPal\Api\CreditCard $credit-cards * @deprecated. Instead use setCreditCards @@ -34,6 +38,7 @@ public function setCredit_cards($credit_cards) { } /** * A list of credit card resources + * * @return PayPal\Api\CreditCard * @deprecated. Instead use getCreditCards */ @@ -43,6 +48,7 @@ public function getCredit_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) { @@ -52,6 +58,7 @@ public function setCount($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 integer */ public function getCount() { @@ -61,6 +68,7 @@ public function getCount() { /** * Identifier of the next element to get the next range of results. + * * @param string $next_id */ public function setNextId($next_id) { @@ -70,6 +78,7 @@ public function setNextId($next_id) { /** * Identifier of the next element to get the next range of results. + * * @return string */ public function getNextId() { @@ -78,6 +87,7 @@ public function getNextId() { /** * Identifier of the next element to get the next range of results. + * * @param string $next_id * @deprecated. Instead use setNextId */ @@ -87,6 +97,7 @@ public function setNext_id($next_id) { } /** * Identifier of the next element to get the next range of results. + * * @return string * @deprecated. Instead use getNextId */ diff --git a/lib/PayPal/Api/CreditCardToken.php b/lib/PayPal/Api/CreditCardToken.php index 13430ddc..6e8c2049 100644 --- a/lib/PayPal/Api/CreditCardToken.php +++ b/lib/PayPal/Api/CreditCardToken.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class CreditCardToken extends PPModel { /** * ID of a previously saved Credit Card resource using /vault/credit-card API. + * * @param string $credit_card_id */ public function setCreditCardId($credit_card_id) { @@ -15,6 +17,7 @@ public function setCreditCardId($credit_card_id) { /** * ID of a previously saved Credit Card resource using /vault/credit-card API. + * * @return string */ public function getCreditCardId() { @@ -23,6 +26,7 @@ public function getCreditCardId() { /** * ID of a previously saved Credit Card resource using /vault/credit-card API. + * * @param string $credit_card_id * @deprecated. Instead use setCreditCardId */ @@ -32,6 +36,7 @@ public function setCredit_card_id($credit_card_id) { } /** * ID of a previously saved Credit Card resource using /vault/credit-card API. + * * @return string * @deprecated. Instead use getCreditCardId */ @@ -41,6 +46,7 @@ public function getCredit_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) { @@ -50,6 +56,7 @@ public function setPayerId($payer_id) { /** * The unique identifier of the payer used when saving this credit card using /vault/credit-card API. + * * @return string */ public function getPayerId() { @@ -58,6 +65,7 @@ public function getPayerId() { /** * 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 */ @@ -67,6 +75,7 @@ public function setPayer_id($payer_id) { } /** * The unique identifier of the payer used when saving this credit card using /vault/credit-card API. + * * @return string * @deprecated. Instead use getPayerId */ @@ -76,6 +85,7 @@ public function getPayer_id() { /** * Last 4 digits of the card number from the saved card. + * * @param string $last4 */ public function setLast4($last4) { @@ -85,6 +95,7 @@ public function setLast4($last4) { /** * Last 4 digits of the card number from the saved card. + * * @return string */ public function getLast4() { @@ -94,6 +105,7 @@ public function getLast4() { /** * 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) { @@ -103,6 +115,7 @@ public function setType($type) { /** * 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() { @@ -112,6 +125,7 @@ public function getType() { /** * card expiry month from the saved card with value 1 - 12 + * * @param integer $expire_month */ public function setExpireMonth($expire_month) { @@ -121,6 +135,7 @@ public function setExpireMonth($expire_month) { /** * card expiry month from the saved card with value 1 - 12 + * * @return integer */ public function getExpireMonth() { @@ -129,6 +144,7 @@ public function getExpireMonth() { /** * card expiry month from the saved card with value 1 - 12 + * * @param integer $expire_month * @deprecated. Instead use setExpireMonth */ @@ -138,6 +154,7 @@ public function setExpire_month($expire_month) { } /** * card expiry month from the saved card with value 1 - 12 + * * @return integer * @deprecated. Instead use getExpireMonth */ @@ -147,6 +164,7 @@ public function getExpire_month() { /** * 4 digit card expiry year from the saved card + * * @param integer $expire_year */ public function setExpireYear($expire_year) { @@ -156,6 +174,7 @@ public function setExpireYear($expire_year) { /** * 4 digit card expiry year from the saved card + * * @return integer */ public function getExpireYear() { @@ -164,6 +183,7 @@ public function getExpireYear() { /** * 4 digit card expiry year from the saved card + * * @param integer $expire_year * @deprecated. Instead use setExpireYear */ @@ -173,6 +193,7 @@ public function setExpire_year($expire_year) { } /** * 4 digit card expiry year from the saved card + * * @return integer * @deprecated. Instead use getExpireYear */ diff --git a/lib/PayPal/Api/Currency.php b/lib/PayPal/Api/Currency.php new file mode 100644 index 00000000..651ef60d --- /dev/null +++ b/lib/PayPal/Api/Currency.php @@ -0,0 +1,48 @@ +currency = $currency; + return $this; + } + + /** + * 3 letter currency code + * + * @return string + */ + public function getCurrency() { + return $this->currency; + } + + + /** + * amount upto 2 decimals represented as string + * + * @param string $value + */ + public function setValue($value) { + $this->value = $value; + return $this; + } + + /** + * amount upto 2 decimals represented as string + * + * @return string + */ + public function getValue() { + return $this->value; + } + + +} diff --git a/lib/PayPal/Api/CustomAmount.php b/lib/PayPal/Api/CustomAmount.php new file mode 100644 index 00000000..0fd89809 --- /dev/null +++ b/lib/PayPal/Api/CustomAmount.php @@ -0,0 +1,48 @@ +label = $label; + return $this; + } + + /** + * Custom amount label. 25 characters max. + * + * @return string + */ + public function getLabel() { + return $this->label; + } + + + /** + * Custom amount value. Range of 0 to 999999.99. + * + * @param PayPal\Api\Currency $amount + */ + public function setAmount($amount) { + $this->amount = $amount; + return $this; + } + + /** + * Custom amount value. Range of 0 to 999999.99. + * + * @return PayPal\Api\Currency + */ + public function getAmount() { + return $this->amount; + } + + +} diff --git a/lib/PayPal/Api/Details.php b/lib/PayPal/Api/Details.php index ab383675..e352b7df 100644 --- a/lib/PayPal/Api/Details.php +++ b/lib/PayPal/Api/Details.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Details extends PPModel { /** * Amount being charged for shipping. + * * @param string $shipping */ public function setShipping($shipping) { @@ -15,6 +17,7 @@ public function setShipping($shipping) { /** * Amount being charged for shipping. + * * @return string */ public function getShipping() { @@ -24,6 +27,7 @@ public function getShipping() { /** * Sub-total (amount) of items being paid for. + * * @param string $subtotal */ public function setSubtotal($subtotal) { @@ -33,6 +37,7 @@ public function setSubtotal($subtotal) { /** * Sub-total (amount) of items being paid for. + * * @return string */ public function getSubtotal() { @@ -42,6 +47,7 @@ public function getSubtotal() { /** * Amount being charged as tax. + * * @param string $tax */ public function setTax($tax) { @@ -51,6 +57,7 @@ public function setTax($tax) { /** * Amount being charged as tax. + * * @return string */ public function getTax() { @@ -60,6 +67,7 @@ public function getTax() { /** * 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) { @@ -69,6 +77,7 @@ public function setFee($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() { diff --git a/lib/PayPal/Api/Error.php b/lib/PayPal/Api/Error.php new file mode 100644 index 00000000..be856fc5 --- /dev/null +++ b/lib/PayPal/Api/Error.php @@ -0,0 +1,147 @@ +name = $name; + return $this; + } + + /** + * Human readable, unique name of the error. + * + * @return string + */ + public function getName() { + return $this->name; + } + + + /** + * PayPal internal identifier used for correlation purposes. + * + * @param string $debug_id + */ + public function setDebugId($debug_id) { + $this->debug_id = $debug_id; + return $this; + } + + /** + * PayPal internal identifier used for correlation purposes. + * + * @return string + */ + public function getDebugId() { + return $this->debug_id; + } + + /** + * PayPal internal identifier used for correlation purposes. + * + * @param string $debug_id + * @deprecated. Instead use setDebugId + */ + public function setDebug_id($debug_id) { + $this->debug_id = $debug_id; + return $this; + } + /** + * PayPal internal identifier used for correlation purposes. + * + * @return string + * @deprecated. Instead use getDebugId + */ + public function getDebug_id() { + return $this->debug_id; + } + + /** + * Message describing the error. + * + * @param string $message + */ + public function setMessage($message) { + $this->message = $message; + return $this; + } + + /** + * Message describing the error. + * + * @return string + */ + public function getMessage() { + return $this->message; + } + + + /** + * URI for detailed information related to this error for the developer. + * + * @param string $information_link + */ + public function setInformationLink($information_link) { + $this->information_link = $information_link; + return $this; + } + + /** + * URI for detailed information related to this error for the developer. + * + * @return string + */ + public function getInformationLink() { + return $this->information_link; + } + + /** + * URI for detailed information related to this error for the developer. + * + * @param string $information_link + * @deprecated. Instead use setInformationLink + */ + public function setInformation_link($information_link) { + $this->information_link = $information_link; + return $this; + } + /** + * URI for detailed information related to this error for the developer. + * + * @return string + * @deprecated. Instead use getInformationLink + */ + public function getInformation_link() { + return $this->information_link; + } + + /** + * Additional details of the error + * + * @array + * @param PayPal\Api\ErrorDetails $details + */ + public function setDetails($details) { + $this->details = $details; + return $this; + } + + /** + * Additional details of the error + * + * @return PayPal\Api\ErrorDetails + */ + public function getDetails() { + return $this->details; + } + + +} diff --git a/lib/PayPal/Api/ErrorDetails.php b/lib/PayPal/Api/ErrorDetails.php new file mode 100644 index 00000000..2b5487a6 --- /dev/null +++ b/lib/PayPal/Api/ErrorDetails.php @@ -0,0 +1,48 @@ +field = $field; + return $this; + } + + /** + * Name of the field that caused the error. + * + * @return string + */ + public function getField() { + return $this->field; + } + + + /** + * Reason for the error. + * + * @param string $issue + */ + public function setIssue($issue) { + $this->issue = $issue; + return $this; + } + + /** + * Reason for the error. + * + * @return string + */ + public function getIssue() { + return $this->issue; + } + + +} diff --git a/lib/PayPal/Api/FundingInstrument.php b/lib/PayPal/Api/FundingInstrument.php index 68006754..0bf4f3a2 100644 --- a/lib/PayPal/Api/FundingInstrument.php +++ b/lib/PayPal/Api/FundingInstrument.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class FundingInstrument extends PPModel { /** * Credit Card information. + * * @param PayPal\Api\CreditCard $credit_card */ public function setCreditCard($credit_card) { @@ -15,6 +17,7 @@ public function setCreditCard($credit_card) { /** * Credit Card information. + * * @return PayPal\Api\CreditCard */ public function getCreditCard() { @@ -23,6 +26,7 @@ public function getCreditCard() { /** * Credit Card information. + * * @param PayPal\Api\CreditCard $credit_card * @deprecated. Instead use setCreditCard */ @@ -32,6 +36,7 @@ public function setCredit_card($credit_card) { } /** * Credit Card information. + * * @return PayPal\Api\CreditCard * @deprecated. Instead use getCreditCard */ @@ -41,6 +46,7 @@ public function getCredit_card() { /** * Credit Card information. + * * @param PayPal\Api\CreditCardToken $credit_card_token */ public function setCreditCardToken($credit_card_token) { @@ -50,6 +56,7 @@ public function setCreditCardToken($credit_card_token) { /** * Credit Card information. + * * @return PayPal\Api\CreditCardToken */ public function getCreditCardToken() { @@ -58,6 +65,7 @@ public function getCreditCardToken() { /** * Credit Card information. + * * @param PayPal\Api\CreditCardToken $credit_card_token * @deprecated. Instead use setCreditCardToken */ @@ -67,6 +75,7 @@ public function setCredit_card_token($credit_card_token) { } /** * Credit Card information. + * * @return PayPal\Api\CreditCardToken * @deprecated. Instead use getCreditCardToken */ diff --git a/lib/PayPal/Api/HyperSchema.php b/lib/PayPal/Api/HyperSchema.php index a09ee928..2b8e9a64 100644 --- a/lib/PayPal/Api/HyperSchema.php +++ b/lib/PayPal/Api/HyperSchema.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class HyperSchema extends PPModel { /** * + * * @array * @param PayPal\Api\Links $links */ @@ -16,6 +18,7 @@ public function setLinks($links) { /** * + * * @return PayPal\Api\Links */ public function getLinks() { @@ -25,6 +28,7 @@ public function getLinks() { /** * + * * @param string $fragmentResolution */ public function setFragmentResolution($fragmentResolution) { @@ -34,6 +38,7 @@ public function setFragmentResolution($fragmentResolution) { /** * + * * @return string */ public function getFragmentResolution() { @@ -43,6 +48,7 @@ public function getFragmentResolution() { /** * + * * @param boolean $readonly */ public function setReadonly($readonly) { @@ -52,6 +58,7 @@ public function setReadonly($readonly) { /** * + * * @return boolean */ public function getReadonly() { @@ -61,6 +68,7 @@ public function getReadonly() { /** * + * * @param string $contentEncoding */ public function setContentEncoding($contentEncoding) { @@ -70,6 +78,7 @@ public function setContentEncoding($contentEncoding) { /** * + * * @return string */ public function getContentEncoding() { @@ -79,6 +88,7 @@ public function getContentEncoding() { /** * + * * @param string $pathStart */ public function setPathStart($pathStart) { @@ -88,6 +98,7 @@ public function setPathStart($pathStart) { /** * + * * @return string */ public function getPathStart() { @@ -97,6 +108,7 @@ public function getPathStart() { /** * + * * @param string $mediaType */ public function setMediaType($mediaType) { @@ -106,6 +118,7 @@ public function setMediaType($mediaType) { /** * + * * @return string */ public function getMediaType() { diff --git a/lib/PayPal/Api/Invoice.php b/lib/PayPal/Api/Invoice.php new file mode 100644 index 00000000..8b83f625 --- /dev/null +++ b/lib/PayPal/Api/Invoice.php @@ -0,0 +1,965 @@ +id = $id; + return $this; + } + + /** + * Unique invoice resource identifier. + * + * @return string + */ + public function getId() { + return $this->id; + } + + + /** + * Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max. + * + * @param string $number + */ + public function setNumber($number) { + $this->number = $number; + return $this; + } + + /** + * Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max. + * + * @return string + */ + public function getNumber() { + return $this->number; + } + + + /** + * URI of the invoice resource. + * + * @param string $uri + */ + public function setUri($uri) { + $this->uri = $uri; + return $this; + } + + /** + * URI of the invoice resource. + * + * @return string + */ + public function getUri() { + return $this->uri; + } + + + /** + * Status of the invoice. + * + * @param string $status + */ + public function setStatus($status) { + $this->status = $status; + return $this; + } + + /** + * Status of the invoice. + * + * @return string + */ + public function getStatus() { + return $this->status; + } + + + /** + * Information about the merchant who is sending the invoice. + * + * @param PayPal\Api\MerchantInfo $merchant_info + */ + public function setMerchantInfo($merchant_info) { + $this->merchant_info = $merchant_info; + return $this; + } + + /** + * Information about the merchant who is sending the invoice. + * + * @return PayPal\Api\MerchantInfo + */ + public function getMerchantInfo() { + return $this->merchant_info; + } + + /** + * Information about the merchant who is sending the invoice. + * + * @param PayPal\Api\MerchantInfo $merchant_info + * @deprecated. Instead use setMerchantInfo + */ + public function setMerchant_info($merchant_info) { + $this->merchant_info = $merchant_info; + return $this; + } + /** + * Information about the merchant who is sending the invoice. + * + * @return PayPal\Api\MerchantInfo + * @deprecated. Instead use getMerchantInfo + */ + public function getMerchant_info() { + return $this->merchant_info; + } + + /** + * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). + * + * @array + * @param PayPal\Api\BillingInfo $billing_info + */ + public function setBillingInfo($billing_info) { + $this->billing_info = $billing_info; + return $this; + } + + /** + * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). + * + * @return PayPal\Api\BillingInfo + */ + public function getBillingInfo() { + return $this->billing_info; + } + + /** + * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). + * + * @array + * @param PayPal\Api\BillingInfo $billing_info + * @deprecated. Instead use setBillingInfo + */ + public function setBilling_info($billing_info) { + $this->billing_info = $billing_info; + return $this; + } + /** + * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). + * + * @return PayPal\Api\BillingInfo + * @deprecated. Instead use getBillingInfo + */ + public function getBilling_info() { + return $this->billing_info; + } + + /** + * Shipping information for entities to whom items are being shipped. + * + * @param PayPal\Api\ShippingInfo $shipping_info + */ + public function setShippingInfo($shipping_info) { + $this->shipping_info = $shipping_info; + return $this; + } + + /** + * Shipping information for entities to whom items are being shipped. + * + * @return PayPal\Api\ShippingInfo + */ + public function getShippingInfo() { + return $this->shipping_info; + } + + /** + * Shipping information for entities to whom items are being shipped. + * + * @param PayPal\Api\ShippingInfo $shipping_info + * @deprecated. Instead use setShippingInfo + */ + public function setShipping_info($shipping_info) { + $this->shipping_info = $shipping_info; + return $this; + } + /** + * Shipping information for entities to whom items are being shipped. + * + * @return PayPal\Api\ShippingInfo + * @deprecated. Instead use getShippingInfo + */ + public function getShipping_info() { + return $this->shipping_info; + } + + /** + * List of items included in the invoice. 100 items max per invoice. + * + * @array + * @param PayPal\Api\InvoiceItem $items + */ + public function setItems($items) { + $this->items = $items; + return $this; + } + + /** + * List of items included in the invoice. 100 items max per invoice. + * + * @return PayPal\Api\InvoiceItem + */ + public function getItems() { + return $this->items; + } + + + /** + * Date on which the invoice was enabled. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @param string $invoice_date + */ + public function setInvoiceDate($invoice_date) { + $this->invoice_date = $invoice_date; + return $this; + } + + /** + * Date on which the invoice was enabled. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @return string + */ + public function getInvoiceDate() { + return $this->invoice_date; + } + + /** + * Date on which the invoice was enabled. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @param string $invoice_date + * @deprecated. Instead use setInvoiceDate + */ + public function setInvoice_date($invoice_date) { + $this->invoice_date = $invoice_date; + return $this; + } + /** + * Date on which the invoice was enabled. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @return string + * @deprecated. Instead use getInvoiceDate + */ + public function getInvoice_date() { + return $this->invoice_date; + } + + /** + * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. + * + * @param PayPal\Api\PaymentTerm $payment_term + */ + public function setPaymentTerm($payment_term) { + $this->payment_term = $payment_term; + return $this; + } + + /** + * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. + * + * @return PayPal\Api\PaymentTerm + */ + public function getPaymentTerm() { + return $this->payment_term; + } + + /** + * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. + * + * @param PayPal\Api\PaymentTerm $payment_term + * @deprecated. Instead use setPaymentTerm + */ + public function setPayment_term($payment_term) { + $this->payment_term = $payment_term; + return $this; + } + /** + * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. + * + * @return PayPal\Api\PaymentTerm + * @deprecated. Instead use getPaymentTerm + */ + public function getPayment_term() { + return $this->payment_term; + } + + /** + * Invoice level discount in percent or amount. + * + * @param PayPal\Api\Cost $discount + */ + public function setDiscount($discount) { + $this->discount = $discount; + return $this; + } + + /** + * Invoice level discount in percent or amount. + * + * @return PayPal\Api\Cost + */ + public function getDiscount() { + return $this->discount; + } + + + /** + * Shipping cost in percent or amount. + * + * @param PayPal\Api\ShippingCost $shipping_cost + */ + public function setShippingCost($shipping_cost) { + $this->shipping_cost = $shipping_cost; + return $this; + } + + /** + * Shipping cost in percent or amount. + * + * @return PayPal\Api\ShippingCost + */ + public function getShippingCost() { + return $this->shipping_cost; + } + + /** + * Shipping cost in percent or amount. + * + * @param PayPal\Api\ShippingCost $shipping_cost + * @deprecated. Instead use setShippingCost + */ + public function setShipping_cost($shipping_cost) { + $this->shipping_cost = $shipping_cost; + return $this; + } + /** + * Shipping cost in percent or amount. + * + * @return PayPal\Api\ShippingCost + * @deprecated. Instead use getShippingCost + */ + public function getShipping_cost() { + return $this->shipping_cost; + } + + /** + * Custom amount applied on an invoice. If a label is included then the amount cannot be empty. + * + * @param PayPal\Api\CustomAmount $custom + */ + public function setCustom($custom) { + $this->custom = $custom; + return $this; + } + + /** + * Custom amount applied on an invoice. If a label is included then the amount cannot be empty. + * + * @return PayPal\Api\CustomAmount + */ + public function getCustom() { + return $this->custom; + } + + + /** + * Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. + * + * @param boolean $tax_calculated_after_discount + */ + public function setTaxCalculatedAfterDiscount($tax_calculated_after_discount) { + $this->tax_calculated_after_discount = $tax_calculated_after_discount; + return $this; + } + + /** + * Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. + * + * @return boolean + */ + public function getTaxCalculatedAfterDiscount() { + return $this->tax_calculated_after_discount; + } + + /** + * Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. + * + * @param boolean $tax_calculated_after_discount + * @deprecated. Instead use setTaxCalculatedAfterDiscount + */ + public function setTax_calculated_after_discount($tax_calculated_after_discount) { + $this->tax_calculated_after_discount = $tax_calculated_after_discount; + return $this; + } + /** + * Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. + * + * @return boolean + * @deprecated. Instead use getTaxCalculatedAfterDiscount + */ + public function getTax_calculated_after_discount() { + return $this->tax_calculated_after_discount; + } + + /** + * A flag indicating whether the unit price includes tax. Default is false + * + * @param boolean $tax_inclusive + */ + public function setTaxInclusive($tax_inclusive) { + $this->tax_inclusive = $tax_inclusive; + return $this; + } + + /** + * A flag indicating whether the unit price includes tax. Default is false + * + * @return boolean + */ + public function getTaxInclusive() { + return $this->tax_inclusive; + } + + /** + * A flag indicating whether the unit price includes tax. Default is false + * + * @param boolean $tax_inclusive + * @deprecated. Instead use setTaxInclusive + */ + public function setTax_inclusive($tax_inclusive) { + $this->tax_inclusive = $tax_inclusive; + return $this; + } + /** + * A flag indicating whether the unit price includes tax. Default is false + * + * @return boolean + * @deprecated. Instead use getTaxInclusive + */ + public function getTax_inclusive() { + return $this->tax_inclusive; + } + + /** + * General terms of the invoice. 4000 characters max. + * + * @param string $terms + */ + public function setTerms($terms) { + $this->terms = $terms; + return $this; + } + + /** + * General terms of the invoice. 4000 characters max. + * + * @return string + */ + public function getTerms() { + return $this->terms; + } + + + /** + * Note to the payer. 4000 characters max. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Note to the payer. 4000 characters max. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + + /** + * Bookkeeping memo that is private to the merchant. 150 characters max. + * + * @param string $merchant_memo + */ + public function setMerchantMemo($merchant_memo) { + $this->merchant_memo = $merchant_memo; + return $this; + } + + /** + * Bookkeeping memo that is private to the merchant. 150 characters max. + * + * @return string + */ + public function getMerchantMemo() { + return $this->merchant_memo; + } + + /** + * Bookkeeping memo that is private to the merchant. 150 characters max. + * + * @param string $merchant_memo + * @deprecated. Instead use setMerchantMemo + */ + public function setMerchant_memo($merchant_memo) { + $this->merchant_memo = $merchant_memo; + return $this; + } + /** + * Bookkeeping memo that is private to the merchant. 150 characters max. + * + * @return string + * @deprecated. Instead use getMerchantMemo + */ + public function getMerchant_memo() { + return $this->merchant_memo; + } + + /** + * Full URL of an external image to use as the logo. 4000 characters max. + * + * @param string $logo_url + */ + public function setLogoUrl($logo_url) { + $this->logo_url = $logo_url; + return $this; + } + + /** + * Full URL of an external image to use as the logo. 4000 characters max. + * + * @return string + */ + public function getLogoUrl() { + return $this->logo_url; + } + + /** + * Full URL of an external image to use as the logo. 4000 characters max. + * + * @param string $logo_url + * @deprecated. Instead use setLogoUrl + */ + public function setLogo_url($logo_url) { + $this->logo_url = $logo_url; + return $this; + } + /** + * Full URL of an external image to use as the logo. 4000 characters max. + * + * @return string + * @deprecated. Instead use getLogoUrl + */ + public function getLogo_url() { + return $this->logo_url; + } + + /** + * The total amount of the invoice. + * + * @param PayPal\Api\Currency $total_amount + */ + public function setTotalAmount($total_amount) { + $this->total_amount = $total_amount; + return $this; + } + + /** + * The total amount of the invoice. + * + * @return PayPal\Api\Currency + */ + public function getTotalAmount() { + return $this->total_amount; + } + + /** + * The total amount of the invoice. + * + * @param PayPal\Api\Currency $total_amount + * @deprecated. Instead use setTotalAmount + */ + public function setTotal_amount($total_amount) { + $this->total_amount = $total_amount; + return $this; + } + /** + * The total amount of the invoice. + * + * @return PayPal\Api\Currency + * @deprecated. Instead use getTotalAmount + */ + public function getTotal_amount() { + return $this->total_amount; + } + + /** + * List of payment details for the invoice. + * + * @array + * @param PayPal\Api\PaymentDetail $payment_details + */ + public function setPaymentDetails($payment_details) { + $this->payment_details = $payment_details; + return $this; + } + + /** + * List of payment details for the invoice. + * + * @return PayPal\Api\PaymentDetail + */ + public function getPaymentDetails() { + return $this->payment_details; + } + + /** + * List of payment details for the invoice. + * + * @array + * @param PayPal\Api\PaymentDetail $payment_details + * @deprecated. Instead use setPaymentDetails + */ + public function setPayment_details($payment_details) { + $this->payment_details = $payment_details; + return $this; + } + /** + * List of payment details for the invoice. + * + * @return PayPal\Api\PaymentDetail + * @deprecated. Instead use getPaymentDetails + */ + public function getPayment_details() { + return $this->payment_details; + } + + /** + * List of refund details for the invoice. + * + * @array + * @param PayPal\Api\RefundDetail $refund_details + */ + public function setRefundDetails($refund_details) { + $this->refund_details = $refund_details; + return $this; + } + + /** + * List of refund details for the invoice. + * + * @return PayPal\Api\RefundDetail + */ + public function getRefundDetails() { + return $this->refund_details; + } + + /** + * List of refund details for the invoice. + * + * @array + * @param PayPal\Api\RefundDetail $refund_details + * @deprecated. Instead use setRefundDetails + */ + public function setRefund_details($refund_details) { + $this->refund_details = $refund_details; + return $this; + } + /** + * List of refund details for the invoice. + * + * @return PayPal\Api\RefundDetail + * @deprecated. Instead use getRefundDetails + */ + public function getRefund_details() { + return $this->refund_details; + } + + /** + * Audit information for the invoice. + * + * @param PayPal\Api\Metadata $metadata + */ + public function setMetadata($metadata) { + $this->metadata = $metadata; + return $this; + } + + /** + * Audit information for the invoice. + * + * @return PayPal\Api\Metadata + */ + public function getMetadata() { + return $this->metadata; + } + + + + /* + * Creates a new invoice Resource. + * + * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @return Invoice + */ + 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/invoicing/invoices", "POST", $payLoad); + $this->fromJson($json); + return $this; + } + + /* + * Search for invoice resources. + * + * @param Search $search + * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @return Invoices + */ + public function search($search, $apiContext = null) { + if (($search == null)) { + throw new \InvalidArgumentException("search cannot be null or empty"); + } + $payLoad = $search->toJSON(); + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/invoicing/search", "POST", $payLoad); + $ret = new Invoices(); + $ret->fromJson($json); + return $ret; + } + + /* + * Sends a legitimate invoice to the payer. + * + * @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 send($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/invoicing/invoices/{$this->getId()}/send", "POST", $payLoad); + return true; + } + + /* + * Reminds the payer to pay the invoice. + * + * @param Notification $notification + * @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 remind($notification, $apiContext = null) { + if ($this->getId() == null) { + throw new \InvalidArgumentException("Id cannot be null"); + } + if (($notification == null)) { + throw new \InvalidArgumentException("notification cannot be null or empty"); + } + $payLoad = $notification->toJSON(); + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/invoicing/invoices/{$this->getId()}/remind", "POST", $payLoad); + return true; + } + + /* + * Cancels an invoice. + * + * @param CancelNotification $cancelNotification + * @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 cancel($cancelNotification, $apiContext = null) { + if ($this->getId() == null) { + throw new \InvalidArgumentException("Id cannot be null"); + } + if (($cancelNotification == null)) { + throw new \InvalidArgumentException("cancelNotification cannot be null or empty"); + } + $payLoad = $cancelNotification->toJSON(); + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/invoicing/invoices/{$this->getId()}/cancel", "POST", $payLoad); + return true; + } + + /* + * Mark the status of the invoice as paid. + * + * @param PaymentDetail $paymentDetail + * @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 record_payment($paymentDetail, $apiContext = null) { + if ($this->getId() == null) { + throw new \InvalidArgumentException("Id cannot be null"); + } + if (($paymentDetail == null)) { + throw new \InvalidArgumentException("paymentDetail cannot be null or empty"); + } + $payLoad = $paymentDetail->toJSON(); + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/invoicing/invoices/{$this->getId()}/record-payment", "POST", $payLoad); + return true; + } + + /* + * Mark the status of the invoice as refunded. + * + * @param RefundDetail $refundDetail + * @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 record_refund($refundDetail, $apiContext = null) { + if ($this->getId() == null) { + throw new \InvalidArgumentException("Id cannot be null"); + } + if (($refundDetail == null)) { + throw new \InvalidArgumentException("refundDetail cannot be null or empty"); + } + $payLoad = $refundDetail->toJSON(); + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/invoicing/invoices/{$this->getId()}/record-refund", "POST", $payLoad); + return true; + } + + /* + * Get the invoice resource for the given identifier. + * + * @param string $invoiceId + * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @return Invoice + */ + public static function get($invoiceId, $apiContext = null) { + if (($invoiceId == null) || (strlen($invoiceId) <= 0)) { + throw new \InvalidArgumentException("invoiceId 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/invoicing/invoices/$invoiceId", "GET", $payLoad); + $ret = new Invoice(); + $ret->fromJson($json); + return $ret; + } + + /* + * Get all invoices of a merchant. + * + * @param PayPal\Rest\ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @return Invoices + */ + public static function get_all($apiContext = null) { + $payLoad = ""; + if ($apiContext == null) { + $apiContext = new ApiContext(self::$credential); + } + $call = new PPRestCall($apiContext); + $json = $call->execute(array('PayPal\Rest\RestHandler'), "/v1/invoicing/invoices/", "GET", $payLoad); + $ret = new Invoices(); + $ret->fromJson($json); + return $ret; + } + + /* + * Full update of the invoice 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 Invoice + */ + 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/invoicing/invoices/{$this->getId()}", "PUT", $payLoad); + $this->fromJson($json); + return $this; + } + + /* + * Delete invoice 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/invoicing/invoices/{$this->getId()}", "DELETE", $payLoad); + return true; + } +} diff --git a/lib/PayPal/Api/InvoiceItem.php b/lib/PayPal/Api/InvoiceItem.php new file mode 100644 index 00000000..aefdaf9c --- /dev/null +++ b/lib/PayPal/Api/InvoiceItem.php @@ -0,0 +1,167 @@ +name = $name; + return $this; + } + + /** + * Name of the item. 60 characters max. + * + * @return string + */ + public function getName() { + return $this->name; + } + + + /** + * Description of the item. 1000 characters max. + * + * @param string $description + */ + public function setDescription($description) { + $this->description = $description; + return $this; + } + + /** + * Description of the item. 1000 characters max. + * + * @return string + */ + public function getDescription() { + return $this->description; + } + + + /** + * Quantity of the item. Range of 0 to 9999.999. + * + * @param PayPal\Api\number $quantity + */ + public function setQuantity($quantity) { + $this->quantity = $quantity; + return $this; + } + + /** + * Quantity of the item. Range of 0 to 9999.999. + * + * @return PayPal\Api\number + */ + public function getQuantity() { + return $this->quantity; + } + + + /** + * Unit price of the item. Range of -999999.99 to 999999.99. + * + * @param PayPal\Api\Currency $unit_price + */ + public function setUnitPrice($unit_price) { + $this->unit_price = $unit_price; + return $this; + } + + /** + * Unit price of the item. Range of -999999.99 to 999999.99. + * + * @return PayPal\Api\Currency + */ + public function getUnitPrice() { + return $this->unit_price; + } + + /** + * Unit price of the item. Range of -999999.99 to 999999.99. + * + * @param PayPal\Api\Currency $unit_price + * @deprecated. Instead use setUnitPrice + */ + public function setUnit_price($unit_price) { + $this->unit_price = $unit_price; + return $this; + } + /** + * Unit price of the item. Range of -999999.99 to 999999.99. + * + * @return PayPal\Api\Currency + * @deprecated. Instead use getUnitPrice + */ + public function getUnit_price() { + return $this->unit_price; + } + + /** + * Tax associated with the item. + * + * @param PayPal\Api\Tax $tax + */ + public function setTax($tax) { + $this->tax = $tax; + return $this; + } + + /** + * Tax associated with the item. + * + * @return PayPal\Api\Tax + */ + public function getTax() { + return $this->tax; + } + + + /** + * Date on which the item or service was provided. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. + * + * @param string $date + */ + public function setDate($date) { + $this->date = $date; + return $this; + } + + /** + * Date on which the item or service was provided. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. + * + * @return string + */ + public function getDate() { + return $this->date; + } + + + /** + * Item discount in percent or amount. + * + * @param PayPal\Api\Cost $discount + */ + public function setDiscount($discount) { + $this->discount = $discount; + return $this; + } + + /** + * Item discount in percent or amount. + * + * @return PayPal\Api\Cost + */ + public function getDiscount() { + return $this->discount; + } + + +} diff --git a/lib/PayPal/Api/Invoices.php b/lib/PayPal/Api/Invoices.php new file mode 100644 index 00000000..e97c3cf5 --- /dev/null +++ b/lib/PayPal/Api/Invoices.php @@ -0,0 +1,68 @@ +total_count = $total_count; + return $this; + } + + /** + * + * + * @return integer + */ + public function getTotalCount() { + return $this->total_count; + } + + /** + * + * + * @param integer $total_count + * @deprecated. Instead use setTotalCount + */ + public function setTotal_count($total_count) { + $this->total_count = $total_count; + return $this; + } + /** + * + * + * @return integer + * @deprecated. Instead use getTotalCount + */ + public function getTotal_count() { + return $this->total_count; + } + + /** + * List of invoices belonging to a merchant. + * + * @array + * @param PayPal\Api\Invoice $invoices + */ + public function setInvoices($invoices) { + $this->invoices = $invoices; + return $this; + } + + /** + * List of invoices belonging to a merchant. + * + * @return PayPal\Api\Invoice + */ + public function getInvoices() { + return $this->invoices; + } + + +} diff --git a/lib/PayPal/Api/InvoicingMetaData.php b/lib/PayPal/Api/InvoicingMetaData.php new file mode 100644 index 00000000..84122ef1 --- /dev/null +++ b/lib/PayPal/Api/InvoicingMetaData.php @@ -0,0 +1,359 @@ +created_date = $created_date; + return $this; + } + + /** + * Date when the resource was created. + * + * @return string + */ + public function getCreatedDate() { + return $this->created_date; + } + + /** + * Date when the resource was created. + * + * @param string $created_date + * @deprecated. Instead use setCreatedDate + */ + public function setCreated_date($created_date) { + $this->created_date = $created_date; + return $this; + } + /** + * Date when the resource was created. + * + * @return string + * @deprecated. Instead use getCreatedDate + */ + public function getCreated_date() { + return $this->created_date; + } + + /** + * Email address of the account that created the resource. + * + * @param string $created_by + */ + public function setCreatedBy($created_by) { + $this->created_by = $created_by; + return $this; + } + + /** + * Email address of the account that created the resource. + * + * @return string + */ + public function getCreatedBy() { + return $this->created_by; + } + + /** + * Email address of the account that created the resource. + * + * @param string $created_by + * @deprecated. Instead use setCreatedBy + */ + public function setCreated_by($created_by) { + $this->created_by = $created_by; + return $this; + } + /** + * Email address of the account that created the resource. + * + * @return string + * @deprecated. Instead use getCreatedBy + */ + public function getCreated_by() { + return $this->created_by; + } + + /** + * Date when the resource was cancelled. + * + * @param string $cancelled_date + */ + public function setCancelledDate($cancelled_date) { + $this->cancelled_date = $cancelled_date; + return $this; + } + + /** + * Date when the resource was cancelled. + * + * @return string + */ + public function getCancelledDate() { + return $this->cancelled_date; + } + + /** + * Date when the resource was cancelled. + * + * @param string $cancelled_date + * @deprecated. Instead use setCancelledDate + */ + public function setCancelled_date($cancelled_date) { + $this->cancelled_date = $cancelled_date; + return $this; + } + /** + * Date when the resource was cancelled. + * + * @return string + * @deprecated. Instead use getCancelledDate + */ + public function getCancelled_date() { + return $this->cancelled_date; + } + + /** + * Actor who cancelled the resource. + * + * @param string $cancelled_by + */ + public function setCancelledBy($cancelled_by) { + $this->cancelled_by = $cancelled_by; + return $this; + } + + /** + * Actor who cancelled the resource. + * + * @return string + */ + public function getCancelledBy() { + return $this->cancelled_by; + } + + /** + * Actor who cancelled the resource. + * + * @param string $cancelled_by + * @deprecated. Instead use setCancelledBy + */ + public function setCancelled_by($cancelled_by) { + $this->cancelled_by = $cancelled_by; + return $this; + } + /** + * Actor who cancelled the resource. + * + * @return string + * @deprecated. Instead use getCancelledBy + */ + public function getCancelled_by() { + return $this->cancelled_by; + } + + /** + * Date when the resource was last edited. + * + * @param string $last_updated_date + */ + public function setLastUpdatedDate($last_updated_date) { + $this->last_updated_date = $last_updated_date; + return $this; + } + + /** + * Date when the resource was last edited. + * + * @return string + */ + public function getLastUpdatedDate() { + return $this->last_updated_date; + } + + /** + * Date when the resource was last edited. + * + * @param string $last_updated_date + * @deprecated. Instead use setLastUpdatedDate + */ + public function setLast_updated_date($last_updated_date) { + $this->last_updated_date = $last_updated_date; + return $this; + } + /** + * Date when the resource was last edited. + * + * @return string + * @deprecated. Instead use getLastUpdatedDate + */ + public function getLast_updated_date() { + return $this->last_updated_date; + } + + /** + * Email address of the account that last edited the resource. + * + * @param string $last_updated_by + */ + public function setLastUpdatedBy($last_updated_by) { + $this->last_updated_by = $last_updated_by; + return $this; + } + + /** + * Email address of the account that last edited the resource. + * + * @return string + */ + public function getLastUpdatedBy() { + return $this->last_updated_by; + } + + /** + * Email address of the account that last edited the resource. + * + * @param string $last_updated_by + * @deprecated. Instead use setLastUpdatedBy + */ + public function setLast_updated_by($last_updated_by) { + $this->last_updated_by = $last_updated_by; + return $this; + } + /** + * Email address of the account that last edited the resource. + * + * @return string + * @deprecated. Instead use getLastUpdatedBy + */ + public function getLast_updated_by() { + return $this->last_updated_by; + } + + /** + * Date when the resource was first sent. + * + * @param string $first_sent_date + */ + public function setFirstSentDate($first_sent_date) { + $this->first_sent_date = $first_sent_date; + return $this; + } + + /** + * Date when the resource was first sent. + * + * @return string + */ + public function getFirstSentDate() { + return $this->first_sent_date; + } + + /** + * Date when the resource was first sent. + * + * @param string $first_sent_date + * @deprecated. Instead use setFirstSentDate + */ + public function setFirst_sent_date($first_sent_date) { + $this->first_sent_date = $first_sent_date; + return $this; + } + /** + * Date when the resource was first sent. + * + * @return string + * @deprecated. Instead use getFirstSentDate + */ + public function getFirst_sent_date() { + return $this->first_sent_date; + } + + /** + * Date when the resource was last sent. + * + * @param string $last_sent_date + */ + public function setLastSentDate($last_sent_date) { + $this->last_sent_date = $last_sent_date; + return $this; + } + + /** + * Date when the resource was last sent. + * + * @return string + */ + public function getLastSentDate() { + return $this->last_sent_date; + } + + /** + * Date when the resource was last sent. + * + * @param string $last_sent_date + * @deprecated. Instead use setLastSentDate + */ + public function setLast_sent_date($last_sent_date) { + $this->last_sent_date = $last_sent_date; + return $this; + } + /** + * Date when the resource was last sent. + * + * @return string + * @deprecated. Instead use getLastSentDate + */ + public function getLast_sent_date() { + return $this->last_sent_date; + } + + /** + * Email address of the account that last sent the resource. + * + * @param string $last_sent_by + */ + public function setLastSentBy($last_sent_by) { + $this->last_sent_by = $last_sent_by; + return $this; + } + + /** + * Email address of the account that last sent the resource. + * + * @return string + */ + public function getLastSentBy() { + return $this->last_sent_by; + } + + /** + * Email address of the account that last sent the resource. + * + * @param string $last_sent_by + * @deprecated. Instead use setLastSentBy + */ + public function setLast_sent_by($last_sent_by) { + $this->last_sent_by = $last_sent_by; + return $this; + } + /** + * Email address of the account that last sent the resource. + * + * @return string + * @deprecated. Instead use getLastSentBy + */ + public function getLast_sent_by() { + return $this->last_sent_by; + } + +} diff --git a/lib/PayPal/Api/InvoicingNotification.php b/lib/PayPal/Api/InvoicingNotification.php new file mode 100644 index 00000000..41a55188 --- /dev/null +++ b/lib/PayPal/Api/InvoicingNotification.php @@ -0,0 +1,87 @@ +subject = $subject; + return $this; + } + + /** + * Subject of the notification. + * + * @return string + */ + public function getSubject() { + return $this->subject; + } + + + /** + * Note to the payer. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Note to the payer. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @param boolean $send_to_merchant + */ + public function setSendToMerchant($send_to_merchant) { + $this->send_to_merchant = $send_to_merchant; + return $this; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @return boolean + */ + public function getSendToMerchant() { + return $this->send_to_merchant; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @param boolean $send_to_merchant + * @deprecated. Instead use setSendToMerchant + */ + public function setSend_to_merchant($send_to_merchant) { + $this->send_to_merchant = $send_to_merchant; + return $this; + } + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @return boolean + * @deprecated. Instead use getSendToMerchant + */ + public function getSend_to_merchant() { + return $this->send_to_merchant; + } + +} diff --git a/lib/PayPal/Api/InvoicingPaymentDetail.php b/lib/PayPal/Api/InvoicingPaymentDetail.php new file mode 100644 index 00000000..a4e0a697 --- /dev/null +++ b/lib/PayPal/Api/InvoicingPaymentDetail.php @@ -0,0 +1,166 @@ +type = $type; + return $this; + } + + /** + * PayPal payment detail indicating whether payment was made in an invoicing flow via PayPal or externally. In the case of the mark-as-paid API, payment type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility. + * + * @return string + */ + public function getType() { + return $this->type; + } + + + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @param string $transaction_id + */ + public function setTransactionId($transaction_id) { + $this->transaction_id = $transaction_id; + return $this; + } + + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @return string + */ + public function getTransactionId() { + return $this->transaction_id; + } + + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @param string $transaction_id + * @deprecated. Instead use setTransactionId + */ + public function setTransaction_id($transaction_id) { + $this->transaction_id = $transaction_id; + return $this; + } + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @return string + * @deprecated. Instead use getTransactionId + */ + public function getTransaction_id() { + return $this->transaction_id; + } + + /** + * Type of the transaction. + * + * @param string $transaction_type + */ + public function setTransactionType($transaction_type) { + $this->transaction_type = $transaction_type; + return $this; + } + + /** + * Type of the transaction. + * + * @return string + */ + public function getTransactionType() { + return $this->transaction_type; + } + + /** + * Type of the transaction. + * + * @param string $transaction_type + * @deprecated. Instead use setTransactionType + */ + public function setTransaction_type($transaction_type) { + $this->transaction_type = $transaction_type; + return $this; + } + /** + * Type of the transaction. + * + * @return string + * @deprecated. Instead use getTransactionType + */ + public function getTransaction_type() { + return $this->transaction_type; + } + + /** + * Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. + * + * @param string $date + */ + public function setDate($date) { + $this->date = $date; + return $this; + } + + /** + * Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. + * + * @return string + */ + public function getDate() { + return $this->date; + } + + + /** + * Payment mode or method. This field is mandatory if the value of the type field is OTHER. + * + * @param string $method + */ + public function setMethod($method) { + $this->method = $method; + return $this; + } + + /** + * Payment mode or method. This field is mandatory if the value of the type field is OTHER. + * + * @return string + */ + public function getMethod() { + return $this->method; + } + + + /** + * Optional note associated with the payment. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Optional note associated with the payment. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + +} diff --git a/lib/PayPal/Api/InvoicingRefundDetail.php b/lib/PayPal/Api/InvoicingRefundDetail.php new file mode 100644 index 00000000..e7859f01 --- /dev/null +++ b/lib/PayPal/Api/InvoicingRefundDetail.php @@ -0,0 +1,68 @@ +type = $type; + return $this; + } + + /** + * PayPal refund type indicating whether refund was done in invoicing flow via PayPal or externally. In the case of the mark-as-refunded API, refund type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility. + * + * @return string + */ + public function getType() { + return $this->type; + } + + + /** + * Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date. + * + * @param string $date + */ + public function setDate($date) { + $this->date = $date; + return $this; + } + + /** + * Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date. + * + * @return string + */ + public function getDate() { + return $this->date; + } + + + /** + * Optional note associated with the refund. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Optional note associated with the refund. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + +} diff --git a/lib/PayPal/Api/InvoicingSearch.php b/lib/PayPal/Api/InvoicingSearch.php new file mode 100644 index 00000000..caf01ed6 --- /dev/null +++ b/lib/PayPal/Api/InvoicingSearch.php @@ -0,0 +1,673 @@ +email = $email; + return $this; + } + + /** + * Initial letters of the email address. + * + * @return string + */ + public function getEmail() { + return $this->email; + } + + + /** + * Initial letters of the recipient's first name. + * + * @param string $recipient_first_name + */ + public function setRecipientFirstName($recipient_first_name) { + $this->recipient_first_name = $recipient_first_name; + return $this; + } + + /** + * Initial letters of the recipient's first name. + * + * @return string + */ + public function getRecipientFirstName() { + return $this->recipient_first_name; + } + + /** + * Initial letters of the recipient's first name. + * + * @param string $recipient_first_name + * @deprecated. Instead use setRecipientFirstName + */ + public function setRecipient_first_name($recipient_first_name) { + $this->recipient_first_name = $recipient_first_name; + return $this; + } + /** + * Initial letters of the recipient's first name. + * + * @return string + * @deprecated. Instead use getRecipientFirstName + */ + public function getRecipient_first_name() { + return $this->recipient_first_name; + } + + /** + * Initial letters of the recipient's last name. + * + * @param string $recipient_last_name + */ + public function setRecipientLastName($recipient_last_name) { + $this->recipient_last_name = $recipient_last_name; + return $this; + } + + /** + * Initial letters of the recipient's last name. + * + * @return string + */ + public function getRecipientLastName() { + return $this->recipient_last_name; + } + + /** + * Initial letters of the recipient's last name. + * + * @param string $recipient_last_name + * @deprecated. Instead use setRecipientLastName + */ + public function setRecipient_last_name($recipient_last_name) { + $this->recipient_last_name = $recipient_last_name; + return $this; + } + /** + * Initial letters of the recipient's last name. + * + * @return string + * @deprecated. Instead use getRecipientLastName + */ + public function getRecipient_last_name() { + return $this->recipient_last_name; + } + + /** + * Initial letters of the recipient's business name. + * + * @param string $recipient_business_name + */ + public function setRecipientBusinessName($recipient_business_name) { + $this->recipient_business_name = $recipient_business_name; + return $this; + } + + /** + * Initial letters of the recipient's business name. + * + * @return string + */ + public function getRecipientBusinessName() { + return $this->recipient_business_name; + } + + /** + * Initial letters of the recipient's business name. + * + * @param string $recipient_business_name + * @deprecated. Instead use setRecipientBusinessName + */ + public function setRecipient_business_name($recipient_business_name) { + $this->recipient_business_name = $recipient_business_name; + return $this; + } + /** + * Initial letters of the recipient's business name. + * + * @return string + * @deprecated. Instead use getRecipientBusinessName + */ + public function getRecipient_business_name() { + return $this->recipient_business_name; + } + + /** + * The invoice number that appears on the invoice. + * + * @param string $number + */ + public function setNumber($number) { + $this->number = $number; + return $this; + } + + /** + * The invoice number that appears on the invoice. + * + * @return string + */ + public function getNumber() { + return $this->number; + } + + + /** + * Status of the invoice. + * + * @param string $status + */ + public function setStatus($status) { + $this->status = $status; + return $this; + } + + /** + * Status of the invoice. + * + * @return string + */ + public function getStatus() { + return $this->status; + } + + + /** + * Lower limit of total amount. + * + * @param PayPal\Api\Currency $lower_total_amount + */ + public function setLowerTotalAmount($lower_total_amount) { + $this->lower_total_amount = $lower_total_amount; + return $this; + } + + /** + * Lower limit of total amount. + * + * @return PayPal\Api\Currency + */ + public function getLowerTotalAmount() { + return $this->lower_total_amount; + } + + /** + * Lower limit of total amount. + * + * @param PayPal\Api\Currency $lower_total_amount + * @deprecated. Instead use setLowerTotalAmount + */ + public function setLower_total_amount($lower_total_amount) { + $this->lower_total_amount = $lower_total_amount; + return $this; + } + /** + * Lower limit of total amount. + * + * @return PayPal\Api\Currency + * @deprecated. Instead use getLowerTotalAmount + */ + public function getLower_total_amount() { + return $this->lower_total_amount; + } + + /** + * Upper limit of total amount. + * + * @param PayPal\Api\Currency $upper_total_amount + */ + public function setUpperTotalAmount($upper_total_amount) { + $this->upper_total_amount = $upper_total_amount; + return $this; + } + + /** + * Upper limit of total amount. + * + * @return PayPal\Api\Currency + */ + public function getUpperTotalAmount() { + return $this->upper_total_amount; + } + + /** + * Upper limit of total amount. + * + * @param PayPal\Api\Currency $upper_total_amount + * @deprecated. Instead use setUpperTotalAmount + */ + public function setUpper_total_amount($upper_total_amount) { + $this->upper_total_amount = $upper_total_amount; + return $this; + } + /** + * Upper limit of total amount. + * + * @return PayPal\Api\Currency + * @deprecated. Instead use getUpperTotalAmount + */ + public function getUpper_total_amount() { + return $this->upper_total_amount; + } + + /** + * Start invoice date. + * + * @param string $start_invoice_date + */ + public function setStartInvoiceDate($start_invoice_date) { + $this->start_invoice_date = $start_invoice_date; + return $this; + } + + /** + * Start invoice date. + * + * @return string + */ + public function getStartInvoiceDate() { + return $this->start_invoice_date; + } + + /** + * Start invoice date. + * + * @param string $start_invoice_date + * @deprecated. Instead use setStartInvoiceDate + */ + public function setStart_invoice_date($start_invoice_date) { + $this->start_invoice_date = $start_invoice_date; + return $this; + } + /** + * Start invoice date. + * + * @return string + * @deprecated. Instead use getStartInvoiceDate + */ + public function getStart_invoice_date() { + return $this->start_invoice_date; + } + + /** + * End invoice date. + * + * @param string $end_invoice_date + */ + public function setEndInvoiceDate($end_invoice_date) { + $this->end_invoice_date = $end_invoice_date; + return $this; + } + + /** + * End invoice date. + * + * @return string + */ + public function getEndInvoiceDate() { + return $this->end_invoice_date; + } + + /** + * End invoice date. + * + * @param string $end_invoice_date + * @deprecated. Instead use setEndInvoiceDate + */ + public function setEnd_invoice_date($end_invoice_date) { + $this->end_invoice_date = $end_invoice_date; + return $this; + } + /** + * End invoice date. + * + * @return string + * @deprecated. Instead use getEndInvoiceDate + */ + public function getEnd_invoice_date() { + return $this->end_invoice_date; + } + + /** + * Start invoice due date. + * + * @param string $start_due_date + */ + public function setStartDueDate($start_due_date) { + $this->start_due_date = $start_due_date; + return $this; + } + + /** + * Start invoice due date. + * + * @return string + */ + public function getStartDueDate() { + return $this->start_due_date; + } + + /** + * Start invoice due date. + * + * @param string $start_due_date + * @deprecated. Instead use setStartDueDate + */ + public function setStart_due_date($start_due_date) { + $this->start_due_date = $start_due_date; + return $this; + } + /** + * Start invoice due date. + * + * @return string + * @deprecated. Instead use getStartDueDate + */ + public function getStart_due_date() { + return $this->start_due_date; + } + + /** + * End invoice due date. + * + * @param string $end_due_date + */ + public function setEndDueDate($end_due_date) { + $this->end_due_date = $end_due_date; + return $this; + } + + /** + * End invoice due date. + * + * @return string + */ + public function getEndDueDate() { + return $this->end_due_date; + } + + /** + * End invoice due date. + * + * @param string $end_due_date + * @deprecated. Instead use setEndDueDate + */ + public function setEnd_due_date($end_due_date) { + $this->end_due_date = $end_due_date; + return $this; + } + /** + * End invoice due date. + * + * @return string + * @deprecated. Instead use getEndDueDate + */ + public function getEnd_due_date() { + return $this->end_due_date; + } + + /** + * Start invoice payment date. + * + * @param string $start_payment_date + */ + public function setStartPaymentDate($start_payment_date) { + $this->start_payment_date = $start_payment_date; + return $this; + } + + /** + * Start invoice payment date. + * + * @return string + */ + public function getStartPaymentDate() { + return $this->start_payment_date; + } + + /** + * Start invoice payment date. + * + * @param string $start_payment_date + * @deprecated. Instead use setStartPaymentDate + */ + public function setStart_payment_date($start_payment_date) { + $this->start_payment_date = $start_payment_date; + return $this; + } + /** + * Start invoice payment date. + * + * @return string + * @deprecated. Instead use getStartPaymentDate + */ + public function getStart_payment_date() { + return $this->start_payment_date; + } + + /** + * End invoice payment date. + * + * @param string $end_payment_date + */ + public function setEndPaymentDate($end_payment_date) { + $this->end_payment_date = $end_payment_date; + return $this; + } + + /** + * End invoice payment date. + * + * @return string + */ + public function getEndPaymentDate() { + return $this->end_payment_date; + } + + /** + * End invoice payment date. + * + * @param string $end_payment_date + * @deprecated. Instead use setEndPaymentDate + */ + public function setEnd_payment_date($end_payment_date) { + $this->end_payment_date = $end_payment_date; + return $this; + } + /** + * End invoice payment date. + * + * @return string + * @deprecated. Instead use getEndPaymentDate + */ + public function getEnd_payment_date() { + return $this->end_payment_date; + } + + /** + * Start invoice creation date. + * + * @param string $start_creation_date + */ + public function setStartCreationDate($start_creation_date) { + $this->start_creation_date = $start_creation_date; + return $this; + } + + /** + * Start invoice creation date. + * + * @return string + */ + public function getStartCreationDate() { + return $this->start_creation_date; + } + + /** + * Start invoice creation date. + * + * @param string $start_creation_date + * @deprecated. Instead use setStartCreationDate + */ + public function setStart_creation_date($start_creation_date) { + $this->start_creation_date = $start_creation_date; + return $this; + } + /** + * Start invoice creation date. + * + * @return string + * @deprecated. Instead use getStartCreationDate + */ + public function getStart_creation_date() { + return $this->start_creation_date; + } + + /** + * End invoice creation date. + * + * @param string $end_creation_date + */ + public function setEndCreationDate($end_creation_date) { + $this->end_creation_date = $end_creation_date; + return $this; + } + + /** + * End invoice creation date. + * + * @return string + */ + public function getEndCreationDate() { + return $this->end_creation_date; + } + + /** + * End invoice creation date. + * + * @param string $end_creation_date + * @deprecated. Instead use setEndCreationDate + */ + public function setEnd_creation_date($end_creation_date) { + $this->end_creation_date = $end_creation_date; + return $this; + } + /** + * End invoice creation date. + * + * @return string + * @deprecated. Instead use getEndCreationDate + */ + public function getEnd_creation_date() { + return $this->end_creation_date; + } + + /** + * Offset of the search results. + * + * @param PayPal\Api\number $page + */ + public function setPage($page) { + $this->page = $page; + return $this; + } + + /** + * Offset of the search results. + * + * @return PayPal\Api\number + */ + public function getPage() { + return $this->page; + } + + + /** + * Page size of the search results. + * + * @param PayPal\Api\number $page_size + */ + public function setPageSize($page_size) { + $this->page_size = $page_size; + return $this; + } + + /** + * Page size of the search results. + * + * @return PayPal\Api\number + */ + public function getPageSize() { + return $this->page_size; + } + + /** + * Page size of the search results. + * + * @param PayPal\Api\number $page_size + * @deprecated. Instead use setPageSize + */ + public function setPage_size($page_size) { + $this->page_size = $page_size; + return $this; + } + /** + * Page size of the search results. + * + * @return PayPal\Api\number + * @deprecated. Instead use getPageSize + */ + public function getPage_size() { + return $this->page_size; + } + + /** + * A flag indicating whether total count is required in the response. + * + * @param boolean $total_count_required + */ + public function setTotalCountRequired($total_count_required) { + $this->total_count_required = $total_count_required; + return $this; + } + + /** + * A flag indicating whether total count is required in the response. + * + * @return boolean + */ + public function getTotalCountRequired() { + return $this->total_count_required; + } + + /** + * A flag indicating whether total count is required in the response. + * + * @param boolean $total_count_required + * @deprecated. Instead use setTotalCountRequired + */ + public function setTotal_count_required($total_count_required) { + $this->total_count_required = $total_count_required; + return $this; + } + /** + * A flag indicating whether total count is required in the response. + * + * @return boolean + * @deprecated. Instead use getTotalCountRequired + */ + public function getTotal_count_required() { + return $this->total_count_required; + } + +} diff --git a/lib/PayPal/Api/Item.php b/lib/PayPal/Api/Item.php index 4a40632c..081650b9 100644 --- a/lib/PayPal/Api/Item.php +++ b/lib/PayPal/Api/Item.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Item extends PPModel { /** * Number of items. + * * @param string $quantity */ public function setQuantity($quantity) { @@ -15,6 +17,7 @@ public function setQuantity($quantity) { /** * Number of items. + * * @return string */ public function getQuantity() { @@ -24,6 +27,7 @@ public function getQuantity() { /** * Name of the item. + * * @param string $name */ public function setName($name) { @@ -33,6 +37,7 @@ public function setName($name) { /** * Name of the item. + * * @return string */ public function getName() { @@ -42,6 +47,7 @@ public function getName() { /** * Cost of the item. + * * @param string $price */ public function setPrice($price) { @@ -51,6 +57,7 @@ public function setPrice($price) { /** * Cost of the item. + * * @return string */ public function getPrice() { @@ -60,6 +67,7 @@ public function getPrice() { /** * 3-letter Currency Code + * * @param string $currency */ public function setCurrency($currency) { @@ -69,6 +77,7 @@ public function setCurrency($currency) { /** * 3-letter Currency Code + * * @return string */ public function getCurrency() { @@ -78,6 +87,7 @@ public function getCurrency() { /** * Number or code to identify the item in your catalog/records. + * * @param string $sku */ public function setSku($sku) { @@ -87,6 +97,7 @@ public function setSku($sku) { /** * Number or code to identify the item in your catalog/records. + * * @return string */ public function getSku() { diff --git a/lib/PayPal/Api/ItemList.php b/lib/PayPal/Api/ItemList.php index e71f3aef..7254b98f 100644 --- a/lib/PayPal/Api/ItemList.php +++ b/lib/PayPal/Api/ItemList.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class ItemList extends PPModel { /** * List of items. + * * @array * @param PayPal\Api\Item $items */ @@ -16,6 +18,7 @@ public function setItems(array $items) { /** * List of items. + * * @return PayPal\Api\Item */ public function getItems() { @@ -25,6 +28,7 @@ public function getItems() { /** * Shipping address. + * * @param PayPal\Api\ShippingAddress $shipping_address */ public function setShippingAddress($shipping_address) { @@ -34,6 +38,7 @@ public function setShippingAddress($shipping_address) { /** * Shipping address. + * * @return PayPal\Api\ShippingAddress */ public function getShippingAddress() { @@ -42,6 +47,7 @@ public function getShippingAddress() { /** * Shipping address. + * * @param PayPal\Api\ShippingAddress $shipping_address * @deprecated. Instead use setShippingAddress */ @@ -51,6 +57,7 @@ public function setShipping_address($shipping_address) { } /** * Shipping address. + * * @return PayPal\Api\ShippingAddress * @deprecated. Instead use getShippingAddress */ diff --git a/lib/PayPal/Api/Links.php b/lib/PayPal/Api/Links.php index 9cbd85e8..a4ee5e71 100644 --- a/lib/PayPal/Api/Links.php +++ b/lib/PayPal/Api/Links.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Links extends PPModel { /** * + * * @param string $href */ public function setHref($href) { @@ -15,6 +17,7 @@ public function setHref($href) { /** * + * * @return string */ public function getHref() { @@ -24,6 +27,7 @@ public function getHref() { /** * + * * @param string $rel */ public function setRel($rel) { @@ -33,6 +37,7 @@ public function setRel($rel) { /** * + * * @return string */ public function getRel() { @@ -42,6 +47,7 @@ public function getRel() { /** * + * * @param PayPal\Api\HyperSchema $targetSchema */ public function setTargetSchema($targetSchema) { @@ -51,6 +57,7 @@ public function setTargetSchema($targetSchema) { /** * + * * @return PayPal\Api\HyperSchema */ public function getTargetSchema() { @@ -60,6 +67,7 @@ public function getTargetSchema() { /** * + * * @param string $method */ public function setMethod($method) { @@ -69,6 +77,7 @@ public function setMethod($method) { /** * + * * @return string */ public function getMethod() { @@ -78,6 +87,7 @@ public function getMethod() { /** * + * * @param string $enctype */ public function setEnctype($enctype) { @@ -87,6 +97,7 @@ public function setEnctype($enctype) { /** * + * * @return string */ public function getEnctype() { @@ -96,6 +107,7 @@ public function getEnctype() { /** * + * * @param PayPal\Api\HyperSchema $schema */ public function setSchema($schema) { @@ -105,6 +117,7 @@ public function setSchema($schema) { /** * + * * @return PayPal\Api\HyperSchema */ public function getSchema() { diff --git a/lib/PayPal/Api/MerchantInfo.php b/lib/PayPal/Api/MerchantInfo.php new file mode 100644 index 00000000..e7c8d6a3 --- /dev/null +++ b/lib/PayPal/Api/MerchantInfo.php @@ -0,0 +1,303 @@ +email = $email; + return $this; + } + + /** + * Email address of the merchant. 260 characters max. + * + * @return string + */ + public function getEmail() { + return $this->email; + } + + + /** + * First name of the merchant. 30 characters max. + * + * @param string $first_name + */ + public function setFirstName($first_name) { + $this->first_name = $first_name; + return $this; + } + + /** + * First name of the merchant. 30 characters max. + * + * @return string + */ + public function getFirstName() { + return $this->first_name; + } + + /** + * First name of the merchant. 30 characters max. + * + * @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 merchant. 30 characters max. + * + * @return string + * @deprecated. Instead use getFirstName + */ + public function getFirst_name() { + return $this->first_name; + } + + /** + * Last name of the merchant. 30 characters max. + * + * @param string $last_name + */ + public function setLastName($last_name) { + $this->last_name = $last_name; + return $this; + } + + /** + * Last name of the merchant. 30 characters max. + * + * @return string + */ + public function getLastName() { + return $this->last_name; + } + + /** + * Last name of the merchant. 30 characters max. + * + * @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 merchant. 30 characters max. + * + * @return string + * @deprecated. Instead use getLastName + */ + public function getLast_name() { + return $this->last_name; + } + + /** + * Address of the merchant. + * + * @param PayPal\Api\Address $address + */ + public function setAddress($address) { + $this->address = $address; + return $this; + } + + /** + * Address of the merchant. + * + * @return PayPal\Api\Address + */ + public function getAddress() { + return $this->address; + } + + + /** + * Company business name of the merchant. 100 characters max. + * + * @param string $business_name + */ + public function setBusinessName($business_name) { + $this->business_name = $business_name; + return $this; + } + + /** + * Company business name of the merchant. 100 characters max. + * + * @return string + */ + public function getBusinessName() { + return $this->business_name; + } + + /** + * Company business name of the merchant. 100 characters max. + * + * @param string $business_name + * @deprecated. Instead use setBusinessName + */ + public function setBusiness_name($business_name) { + $this->business_name = $business_name; + return $this; + } + /** + * Company business name of the merchant. 100 characters max. + * + * @return string + * @deprecated. Instead use getBusinessName + */ + public function getBusiness_name() { + return $this->business_name; + } + + /** + * Phone number of the merchant. + * + * @param PayPal\Api\Phone $phone + */ + public function setPhone($phone) { + $this->phone = $phone; + return $this; + } + + /** + * Phone number of the merchant. + * + * @return PayPal\Api\Phone + */ + public function getPhone() { + return $this->phone; + } + + + /** + * Fax number of the merchant. + * + * @param PayPal\Api\Phone $fax + */ + public function setFax($fax) { + $this->fax = $fax; + return $this; + } + + /** + * Fax number of the merchant. + * + * @return PayPal\Api\Phone + */ + public function getFax() { + return $this->fax; + } + + + /** + * Website of the merchant. 2048 characters max. + * + * @param string $website + */ + public function setWebsite($website) { + $this->website = $website; + return $this; + } + + /** + * Website of the merchant. 2048 characters max. + * + * @return string + */ + public function getWebsite() { + return $this->website; + } + + + /** + * Tax ID of the merchant. 100 characters max. + * + * @param string $tax_id + */ + public function setTaxId($tax_id) { + $this->tax_id = $tax_id; + return $this; + } + + /** + * Tax ID of the merchant. 100 characters max. + * + * @return string + */ + public function getTaxId() { + return $this->tax_id; + } + + /** + * Tax ID of the merchant. 100 characters max. + * + * @param string $tax_id + * @deprecated. Instead use setTaxId + */ + public function setTax_id($tax_id) { + $this->tax_id = $tax_id; + return $this; + } + /** + * Tax ID of the merchant. 100 characters max. + * + * @return string + * @deprecated. Instead use getTaxId + */ + public function getTax_id() { + return $this->tax_id; + } + + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @param string $additional_info + */ + public function setAdditionalInfo($additional_info) { + $this->additional_info = $additional_info; + return $this; + } + + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @return string + */ + public function getAdditionalInfo() { + return $this->additional_info; + } + + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @param string $additional_info + * @deprecated. Instead use setAdditionalInfo + */ + public function setAdditional_info($additional_info) { + $this->additional_info = $additional_info; + return $this; + } + /** + * Option to display additional information such as business hours. 40 characters max. + * + * @return string + * @deprecated. Instead use getAdditionalInfo + */ + public function getAdditional_info() { + return $this->additional_info; + } + +} diff --git a/lib/PayPal/Api/Metadata.php b/lib/PayPal/Api/Metadata.php new file mode 100644 index 00000000..30383ad0 --- /dev/null +++ b/lib/PayPal/Api/Metadata.php @@ -0,0 +1,359 @@ +created_date = $created_date; + return $this; + } + + /** + * Date when the resource was created. + * + * @return string + */ + public function getCreatedDate() { + return $this->created_date; + } + + /** + * Date when the resource was created. + * + * @param string $created_date + * @deprecated. Instead use setCreatedDate + */ + public function setCreated_date($created_date) { + $this->created_date = $created_date; + return $this; + } + /** + * Date when the resource was created. + * + * @return string + * @deprecated. Instead use getCreatedDate + */ + public function getCreated_date() { + return $this->created_date; + } + + /** + * Email address of the account that created the resource. + * + * @param string $created_by + */ + public function setCreatedBy($created_by) { + $this->created_by = $created_by; + return $this; + } + + /** + * Email address of the account that created the resource. + * + * @return string + */ + public function getCreatedBy() { + return $this->created_by; + } + + /** + * Email address of the account that created the resource. + * + * @param string $created_by + * @deprecated. Instead use setCreatedBy + */ + public function setCreated_by($created_by) { + $this->created_by = $created_by; + return $this; + } + /** + * Email address of the account that created the resource. + * + * @return string + * @deprecated. Instead use getCreatedBy + */ + public function getCreated_by() { + return $this->created_by; + } + + /** + * Date when the resource was cancelled. + * + * @param string $cancelled_date + */ + public function setCancelledDate($cancelled_date) { + $this->cancelled_date = $cancelled_date; + return $this; + } + + /** + * Date when the resource was cancelled. + * + * @return string + */ + public function getCancelledDate() { + return $this->cancelled_date; + } + + /** + * Date when the resource was cancelled. + * + * @param string $cancelled_date + * @deprecated. Instead use setCancelledDate + */ + public function setCancelled_date($cancelled_date) { + $this->cancelled_date = $cancelled_date; + return $this; + } + /** + * Date when the resource was cancelled. + * + * @return string + * @deprecated. Instead use getCancelledDate + */ + public function getCancelled_date() { + return $this->cancelled_date; + } + + /** + * Actor who cancelled the resource. + * + * @param string $cancelled_by + */ + public function setCancelledBy($cancelled_by) { + $this->cancelled_by = $cancelled_by; + return $this; + } + + /** + * Actor who cancelled the resource. + * + * @return string + */ + public function getCancelledBy() { + return $this->cancelled_by; + } + + /** + * Actor who cancelled the resource. + * + * @param string $cancelled_by + * @deprecated. Instead use setCancelledBy + */ + public function setCancelled_by($cancelled_by) { + $this->cancelled_by = $cancelled_by; + return $this; + } + /** + * Actor who cancelled the resource. + * + * @return string + * @deprecated. Instead use getCancelledBy + */ + public function getCancelled_by() { + return $this->cancelled_by; + } + + /** + * Date when the resource was last edited. + * + * @param string $last_updated_date + */ + public function setLastUpdatedDate($last_updated_date) { + $this->last_updated_date = $last_updated_date; + return $this; + } + + /** + * Date when the resource was last edited. + * + * @return string + */ + public function getLastUpdatedDate() { + return $this->last_updated_date; + } + + /** + * Date when the resource was last edited. + * + * @param string $last_updated_date + * @deprecated. Instead use setLastUpdatedDate + */ + public function setLast_updated_date($last_updated_date) { + $this->last_updated_date = $last_updated_date; + return $this; + } + /** + * Date when the resource was last edited. + * + * @return string + * @deprecated. Instead use getLastUpdatedDate + */ + public function getLast_updated_date() { + return $this->last_updated_date; + } + + /** + * Email address of the account that last edited the resource. + * + * @param string $last_updated_by + */ + public function setLastUpdatedBy($last_updated_by) { + $this->last_updated_by = $last_updated_by; + return $this; + } + + /** + * Email address of the account that last edited the resource. + * + * @return string + */ + public function getLastUpdatedBy() { + return $this->last_updated_by; + } + + /** + * Email address of the account that last edited the resource. + * + * @param string $last_updated_by + * @deprecated. Instead use setLastUpdatedBy + */ + public function setLast_updated_by($last_updated_by) { + $this->last_updated_by = $last_updated_by; + return $this; + } + /** + * Email address of the account that last edited the resource. + * + * @return string + * @deprecated. Instead use getLastUpdatedBy + */ + public function getLast_updated_by() { + return $this->last_updated_by; + } + + /** + * Date when the resource was first sent. + * + * @param string $first_sent_date + */ + public function setFirstSentDate($first_sent_date) { + $this->first_sent_date = $first_sent_date; + return $this; + } + + /** + * Date when the resource was first sent. + * + * @return string + */ + public function getFirstSentDate() { + return $this->first_sent_date; + } + + /** + * Date when the resource was first sent. + * + * @param string $first_sent_date + * @deprecated. Instead use setFirstSentDate + */ + public function setFirst_sent_date($first_sent_date) { + $this->first_sent_date = $first_sent_date; + return $this; + } + /** + * Date when the resource was first sent. + * + * @return string + * @deprecated. Instead use getFirstSentDate + */ + public function getFirst_sent_date() { + return $this->first_sent_date; + } + + /** + * Date when the resource was last sent. + * + * @param string $last_sent_date + */ + public function setLastSentDate($last_sent_date) { + $this->last_sent_date = $last_sent_date; + return $this; + } + + /** + * Date when the resource was last sent. + * + * @return string + */ + public function getLastSentDate() { + return $this->last_sent_date; + } + + /** + * Date when the resource was last sent. + * + * @param string $last_sent_date + * @deprecated. Instead use setLastSentDate + */ + public function setLast_sent_date($last_sent_date) { + $this->last_sent_date = $last_sent_date; + return $this; + } + /** + * Date when the resource was last sent. + * + * @return string + * @deprecated. Instead use getLastSentDate + */ + public function getLast_sent_date() { + return $this->last_sent_date; + } + + /** + * Email address of the account that last sent the resource. + * + * @param string $last_sent_by + */ + public function setLastSentBy($last_sent_by) { + $this->last_sent_by = $last_sent_by; + return $this; + } + + /** + * Email address of the account that last sent the resource. + * + * @return string + */ + public function getLastSentBy() { + return $this->last_sent_by; + } + + /** + * Email address of the account that last sent the resource. + * + * @param string $last_sent_by + * @deprecated. Instead use setLastSentBy + */ + public function setLast_sent_by($last_sent_by) { + $this->last_sent_by = $last_sent_by; + return $this; + } + /** + * Email address of the account that last sent the resource. + * + * @return string + * @deprecated. Instead use getLastSentBy + */ + public function getLast_sent_by() { + return $this->last_sent_by; + } + +} diff --git a/lib/PayPal/Api/Notification.php b/lib/PayPal/Api/Notification.php new file mode 100644 index 00000000..b23b2f8e --- /dev/null +++ b/lib/PayPal/Api/Notification.php @@ -0,0 +1,87 @@ +subject = $subject; + return $this; + } + + /** + * Subject of the notification. + * + * @return string + */ + public function getSubject() { + return $this->subject; + } + + + /** + * Note to the payer. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Note to the payer. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @param boolean $send_to_merchant + */ + public function setSendToMerchant($send_to_merchant) { + $this->send_to_merchant = $send_to_merchant; + return $this; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @return boolean + */ + public function getSendToMerchant() { + return $this->send_to_merchant; + } + + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @param boolean $send_to_merchant + * @deprecated. Instead use setSendToMerchant + */ + public function setSend_to_merchant($send_to_merchant) { + $this->send_to_merchant = $send_to_merchant; + return $this; + } + /** + * A flag indicating whether a copy of the email has to be sent to the merchant. + * + * @return boolean + * @deprecated. Instead use getSendToMerchant + */ + public function getSend_to_merchant() { + return $this->send_to_merchant; + } + +} diff --git a/lib/PayPal/Api/Payee.php b/lib/PayPal/Api/Payee.php index d0ccea3e..97b3cab8 100644 --- a/lib/PayPal/Api/Payee.php +++ b/lib/PayPal/Api/Payee.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Payee extends PPModel { /** * Email Address associated with the Payee's PayPal Account. If the provided email address is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments. Direct Credit Card Payments will be denied due to card compliance requirements. + * * @param string $email */ public function setEmail($email) { @@ -15,6 +17,7 @@ public function setEmail($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() { @@ -24,6 +27,7 @@ public function getEmail() { /** * Encrypted PayPal Account identifier for the Payee. + * * @param string $merchant_id */ public function setMerchantId($merchant_id) { @@ -33,6 +37,7 @@ public function setMerchantId($merchant_id) { /** * Encrypted PayPal Account identifier for the Payee. + * * @return string */ public function getMerchantId() { @@ -41,6 +46,7 @@ public function getMerchantId() { /** * Encrypted PayPal Account identifier for the Payee. + * * @param string $merchant_id * @deprecated. Instead use setMerchantId */ @@ -50,6 +56,7 @@ public function setMerchant_id($merchant_id) { } /** * Encrypted PayPal Account identifier for the Payee. + * * @return string * @deprecated. Instead use getMerchantId */ @@ -59,6 +66,7 @@ public function getMerchant_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) { @@ -68,6 +76,7 @@ public function setPhone($phone) { /** * 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() { diff --git a/lib/PayPal/Api/Payer.php b/lib/PayPal/Api/Payer.php index d21d238c..6e9b7260 100644 --- a/lib/PayPal/Api/Payer.php +++ b/lib/PayPal/Api/Payer.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Payer extends PPModel { /** * Payment method being used - PayPal Wallet payment or Direct Credit card. + * * @param string $payment_method */ public function setPaymentMethod($payment_method) { @@ -15,6 +17,7 @@ public function setPaymentMethod($payment_method) { /** * Payment method being used - PayPal Wallet payment or Direct Credit card. + * * @return string */ public function getPaymentMethod() { @@ -23,6 +26,7 @@ public function getPaymentMethod() { /** * Payment method being used - PayPal Wallet payment or Direct Credit card. + * * @param string $payment_method * @deprecated. Instead use setPaymentMethod */ @@ -32,6 +36,7 @@ public function setPayment_method($payment_method) { } /** * Payment method being used - PayPal Wallet payment or Direct Credit card. + * * @return string * @deprecated. Instead use getPaymentMethod */ @@ -41,6 +46,7 @@ public function getPayment_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 */ @@ -51,6 +57,7 @@ public function setFundingInstruments($funding_instruments) { /** * 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() { @@ -59,6 +66,7 @@ public function getFundingInstruments() { /** * 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 @@ -69,6 +77,7 @@ public function setFunding_instruments($funding_instruments) { } /** * 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 */ @@ -78,6 +87,7 @@ public function getFunding_instruments() { /** * Information related to the Payer. In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet. + * * @param PayPal\Api\PayerInfo $payer_info */ public function setPayerInfo($payer_info) { @@ -87,6 +97,7 @@ public function setPayerInfo($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. + * * @return PayPal\Api\PayerInfo */ public function getPayerInfo() { @@ -95,6 +106,7 @@ public function getPayerInfo() { /** * 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 */ @@ -104,6 +116,7 @@ public function setPayer_info($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. + * * @return PayPal\Api\PayerInfo * @deprecated. Instead use getPayerInfo */ diff --git a/lib/PayPal/Api/PayerInfo.php b/lib/PayPal/Api/PayerInfo.php index a9ff5963..8d1a5a6f 100644 --- a/lib/PayPal/Api/PayerInfo.php +++ b/lib/PayPal/Api/PayerInfo.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class PayerInfo extends PPModel { /** * Email address representing the Payer. + * * @param string $email */ public function setEmail($email) { @@ -15,6 +17,7 @@ public function setEmail($email) { /** * Email address representing the Payer. + * * @return string */ public function getEmail() { @@ -24,6 +27,7 @@ public function getEmail() { /** * First Name of the Payer from their PayPal Account. + * * @param string $first_name */ public function setFirstName($first_name) { @@ -33,6 +37,7 @@ public function setFirstName($first_name) { /** * First Name of the Payer from their PayPal Account. + * * @return string */ public function getFirstName() { @@ -41,6 +46,7 @@ public function getFirstName() { /** * First Name of the Payer from their PayPal Account. + * * @param string $first_name * @deprecated. Instead use setFirstName */ @@ -50,6 +56,7 @@ public function setFirst_name($first_name) { } /** * First Name of the Payer from their PayPal Account. + * * @return string * @deprecated. Instead use getFirstName */ @@ -59,6 +66,7 @@ public function getFirst_name() { /** * Last Name of the Payer from their PayPal Account. + * * @param string $last_name */ public function setLastName($last_name) { @@ -68,6 +76,7 @@ public function setLastName($last_name) { /** * Last Name of the Payer from their PayPal Account. + * * @return string */ public function getLastName() { @@ -76,6 +85,7 @@ public function getLastName() { /** * Last Name of the Payer from their PayPal Account. + * * @param string $last_name * @deprecated. Instead use setLastName */ @@ -85,6 +95,7 @@ public function setLast_name($last_name) { } /** * Last Name of the Payer from their PayPal Account. + * * @return string * @deprecated. Instead use getLastName */ @@ -94,6 +105,7 @@ public function getLast_name() { /** * PayPal assigned Payer ID. + * * @param string $payer_id */ public function setPayerId($payer_id) { @@ -103,6 +115,7 @@ public function setPayerId($payer_id) { /** * PayPal assigned Payer ID. + * * @return string */ public function getPayerId() { @@ -111,6 +124,7 @@ public function getPayerId() { /** * PayPal assigned Payer ID. + * * @param string $payer_id * @deprecated. Instead use setPayerId */ @@ -120,6 +134,7 @@ public function setPayer_id($payer_id) { } /** * PayPal assigned Payer ID. + * * @return string * @deprecated. Instead use getPayerId */ @@ -129,6 +144,7 @@ public function getPayer_id() { /** * Phone number representing the Payer. + * * @param string $phone */ public function setPhone($phone) { @@ -138,6 +154,7 @@ public function setPhone($phone) { /** * Phone number representing the Payer. + * * @return string */ public function getPhone() { @@ -147,6 +164,7 @@ public function getPhone() { /** * Shipping address of the Payer from their PayPal Account. + * * @param PayPal\Api\Address $shipping_address */ public function setShippingAddress($shipping_address) { @@ -156,6 +174,7 @@ public function setShippingAddress($shipping_address) { /** * Shipping address of the Payer from their PayPal Account. + * * @return PayPal\Api\Address */ public function getShippingAddress() { @@ -164,6 +183,7 @@ public function getShippingAddress() { /** * Shipping address of the Payer from their PayPal Account. + * * @param PayPal\Api\Address $shipping_address * @deprecated. Instead use setShippingAddress */ @@ -173,6 +193,7 @@ public function setShipping_address($shipping_address) { } /** * Shipping address of the Payer from their PayPal Account. + * * @return PayPal\Api\Address * @deprecated. Instead use getShippingAddress */ diff --git a/lib/PayPal/Api/Payment.php b/lib/PayPal/Api/Payment.php index 80695f46..076ddc5c 100644 --- a/lib/PayPal/Api/Payment.php +++ b/lib/PayPal/Api/Payment.php @@ -2,10 +2,8 @@ namespace PayPal\Api; use PayPal\Common\PPModel; -use PayPal\Rest\IResource; -use PayPal\Rest\Call; use PayPal\Rest\ApiContext; -use PayPal\Api\Payment; +use PayPal\Rest\IResource; use PayPal\Api\PaymentHistory; use PayPal\Transport\PPRestCall; @@ -23,6 +21,7 @@ public static function setCredential($credential) { /** * Identifier of the payment resource created. + * * @param string $id */ public function setId($id) { @@ -32,6 +31,7 @@ public function setId($id) { /** * Identifier of the payment resource created. + * * @return string */ public function getId() { @@ -41,6 +41,7 @@ public function getId() { /** * Time the resource was created. + * * @param string $create_time */ public function setCreateTime($create_time) { @@ -50,6 +51,7 @@ public function setCreateTime($create_time) { /** * Time the resource was created. + * * @return string */ public function getCreateTime() { @@ -58,6 +60,7 @@ public function getCreateTime() { /** * Time the resource was created. + * * @param string $create_time * @deprecated. Instead use setCreateTime */ @@ -67,6 +70,7 @@ public function setCreate_time($create_time) { } /** * Time the resource was created. + * * @return string * @deprecated. Instead use getCreateTime */ @@ -76,6 +80,7 @@ public function getCreate_time() { /** * Time the resource was last updated. + * * @param string $update_time */ public function setUpdateTime($update_time) { @@ -85,6 +90,7 @@ public function setUpdateTime($update_time) { /** * Time the resource was last updated. + * * @return string */ public function getUpdateTime() { @@ -93,6 +99,7 @@ public function getUpdateTime() { /** * Time the resource was last updated. + * * @param string $update_time * @deprecated. Instead use setUpdateTime */ @@ -102,6 +109,7 @@ public function setUpdate_time($update_time) { } /** * Time the resource was last updated. + * * @return string * @deprecated. Instead use getUpdateTime */ @@ -111,6 +119,7 @@ public function getUpdate_time() { /** * Intent of the payment - Sale or Authorization or Order. + * * @param string $intent */ public function setIntent($intent) { @@ -120,6 +129,7 @@ public function setIntent($intent) { /** * Intent of the payment - Sale or Authorization or Order. + * * @return string */ public function getIntent() { @@ -129,6 +139,7 @@ public function getIntent() { /** * 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) { @@ -138,6 +149,7 @@ public function setPayer($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() { @@ -147,6 +159,7 @@ public function getPayer() { /** * 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 */ @@ -157,6 +170,7 @@ public function setTransactions(array $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() { @@ -166,6 +180,7 @@ public function getTransactions() { /** * state of the payment + * * @param string $state */ public function setState($state) { @@ -175,6 +190,7 @@ public function setState($state) { /** * state of the payment + * * @return string */ public function getState() { @@ -184,6 +200,7 @@ public function getState() { /** * 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) { @@ -193,6 +210,7 @@ public function setRedirectUrls($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() { @@ -201,6 +219,7 @@ public function getRedirectUrls() { /** * 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 */ @@ -210,6 +229,7 @@ public function setRedirect_urls($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 * @deprecated. Instead use getRedirectUrls */ @@ -219,6 +239,7 @@ public function getRedirect_urls() { /** * + * * @array * @param PayPal\Api\Links $links */ @@ -229,6 +250,7 @@ public function setLinks($links) { /** * + * * @return PayPal\Api\Links */ public function getLinks() { @@ -237,6 +259,12 @@ public function getLinks() { + /* + * 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) { @@ -248,6 +276,13 @@ public function create($apiContext = null) { 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"); @@ -263,6 +298,13 @@ public static function get($paymentId, $apiContext = null) { 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"); @@ -281,6 +323,13 @@ public function execute($paymentExecution, $apiContext = null) { 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"); diff --git a/lib/PayPal/Api/PaymentDetail.php b/lib/PayPal/Api/PaymentDetail.php new file mode 100644 index 00000000..fe31f51b --- /dev/null +++ b/lib/PayPal/Api/PaymentDetail.php @@ -0,0 +1,166 @@ +type = $type; + return $this; + } + + /** + * PayPal payment detail indicating whether payment was made in an invoicing flow via PayPal or externally. In the case of the mark-as-paid API, payment type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility. + * + * @return string + */ + public function getType() { + return $this->type; + } + + + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @param string $transaction_id + */ + public function setTransactionId($transaction_id) { + $this->transaction_id = $transaction_id; + return $this; + } + + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @return string + */ + public function getTransactionId() { + return $this->transaction_id; + } + + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @param string $transaction_id + * @deprecated. Instead use setTransactionId + */ + public function setTransaction_id($transaction_id) { + $this->transaction_id = $transaction_id; + return $this; + } + /** + * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * + * @return string + * @deprecated. Instead use getTransactionId + */ + public function getTransaction_id() { + return $this->transaction_id; + } + + /** + * Type of the transaction. + * + * @param string $transaction_type + */ + public function setTransactionType($transaction_type) { + $this->transaction_type = $transaction_type; + return $this; + } + + /** + * Type of the transaction. + * + * @return string + */ + public function getTransactionType() { + return $this->transaction_type; + } + + /** + * Type of the transaction. + * + * @param string $transaction_type + * @deprecated. Instead use setTransactionType + */ + public function setTransaction_type($transaction_type) { + $this->transaction_type = $transaction_type; + return $this; + } + /** + * Type of the transaction. + * + * @return string + * @deprecated. Instead use getTransactionType + */ + public function getTransaction_type() { + return $this->transaction_type; + } + + /** + * Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. + * + * @param string $date + */ + public function setDate($date) { + $this->date = $date; + return $this; + } + + /** + * Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. + * + * @return string + */ + public function getDate() { + return $this->date; + } + + + /** + * Payment mode or method. This field is mandatory if the value of the type field is OTHER. + * + * @param string $method + */ + public function setMethod($method) { + $this->method = $method; + return $this; + } + + /** + * Payment mode or method. This field is mandatory if the value of the type field is OTHER. + * + * @return string + */ + public function getMethod() { + return $this->method; + } + + + /** + * Optional note associated with the payment. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Optional note associated with the payment. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + +} diff --git a/lib/PayPal/Api/PaymentExecution.php b/lib/PayPal/Api/PaymentExecution.php index b7048ebf..49665c01 100644 --- a/lib/PayPal/Api/PaymentExecution.php +++ b/lib/PayPal/Api/PaymentExecution.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class PaymentExecution extends PPModel { /** * PayPal assigned Payer ID returned in the approval return url. + * * @param string $payer_id */ public function setPayerId($payer_id) { @@ -15,6 +17,7 @@ public function setPayerId($payer_id) { /** * PayPal assigned Payer ID returned in the approval return url. + * * @return string */ public function getPayerId() { @@ -23,6 +26,7 @@ public function getPayerId() { /** * PayPal assigned Payer ID returned in the approval return url. + * * @param string $payer_id * @deprecated. Instead use setPayerId */ @@ -32,6 +36,7 @@ public function setPayer_id($payer_id) { } /** * PayPal assigned Payer ID returned in the approval return url. + * * @return string * @deprecated. Instead use getPayerId */ @@ -41,6 +46,7 @@ public function getPayer_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 */ @@ -51,6 +57,7 @@ public function setTransactions($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() { diff --git a/lib/PayPal/Api/PaymentHistory.php b/lib/PayPal/Api/PaymentHistory.php index e9f28af1..be1ba248 100644 --- a/lib/PayPal/Api/PaymentHistory.php +++ b/lib/PayPal/Api/PaymentHistory.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class PaymentHistory extends PPModel { /** * A list of Payment resources + * * @array * @param PayPal\Api\Payment $payments */ @@ -16,6 +18,7 @@ public function setPayments($payments) { /** * A list of Payment resources + * * @return PayPal\Api\Payment */ public function getPayments() { @@ -25,6 +28,7 @@ public function getPayments() { /** * 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) { @@ -34,6 +38,7 @@ public function setCount($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 integer */ public function getCount() { @@ -43,6 +48,7 @@ public function getCount() { /** * Identifier of the next element to get the next range of results. + * * @param string $next_id */ public function setNextId($next_id) { @@ -52,6 +58,7 @@ public function setNextId($next_id) { /** * Identifier of the next element to get the next range of results. + * * @return string */ public function getNextId() { @@ -60,6 +67,7 @@ public function getNextId() { /** * Identifier of the next element to get the next range of results. + * * @param string $next_id * @deprecated. Instead use setNextId */ @@ -69,6 +77,7 @@ public function setNext_id($next_id) { } /** * Identifier of the next element to get the next range of results. + * * @return string * @deprecated. Instead use getNextId */ diff --git a/lib/PayPal/Api/PaymentTerm.php b/lib/PayPal/Api/PaymentTerm.php new file mode 100644 index 00000000..59202082 --- /dev/null +++ b/lib/PayPal/Api/PaymentTerm.php @@ -0,0 +1,86 @@ +term_type = $term_type; + return $this; + } + + /** + * Terms by which the invoice payment is due. + * + * @return string + */ + public function getTermType() { + return $this->term_type; + } + + /** + * Terms by which the invoice payment is due. + * + * @param string $term_type + * @deprecated. Instead use setTermType + */ + public function setTerm_type($term_type) { + $this->term_type = $term_type; + return $this; + } + /** + * Terms by which the invoice payment is due. + * + * @return string + * @deprecated. Instead use getTermType + */ + public function getTerm_type() { + return $this->term_type; + } + + /** + * Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @param string $due_date + */ + public function setDueDate($due_date) { + $this->due_date = $due_date; + return $this; + } + + /** + * Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @return string + */ + public function getDueDate() { + return $this->due_date; + } + + /** + * Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @param string $due_date + * @deprecated. Instead use setDueDate + */ + public function setDue_date($due_date) { + $this->due_date = $due_date; + return $this; + } + /** + * Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST + * + * @return string + * @deprecated. Instead use getDueDate + */ + public function getDue_date() { + return $this->due_date; + } + +} diff --git a/lib/PayPal/Api/Phone.php b/lib/PayPal/Api/Phone.php new file mode 100644 index 00000000..76605b6e --- /dev/null +++ b/lib/PayPal/Api/Phone.php @@ -0,0 +1,86 @@ +country_code = $country_code; + return $this; + } + + /** + * Country code (in E.164 format). Assume length is n. + * + * @return string + */ + public function getCountryCode() { + return $this->country_code; + } + + /** + * Country code (in E.164 format). Assume length is n. + * + * @param string $country_code + * @deprecated. Instead use setCountryCode + */ + public function setCountry_code($country_code) { + $this->country_code = $country_code; + return $this; + } + /** + * Country code (in E.164 format). Assume length is n. + * + * @return string + * @deprecated. Instead use getCountryCode + */ + public function getCountry_code() { + return $this->country_code; + } + + /** + * In-country phone number (in E.164 format). Maximum (15 - n) digits. + * + * @param string $national_number + */ + public function setNationalNumber($national_number) { + $this->national_number = $national_number; + return $this; + } + + /** + * In-country phone number (in E.164 format). Maximum (15 - n) digits. + * + * @return string + */ + public function getNationalNumber() { + return $this->national_number; + } + + /** + * In-country phone number (in E.164 format). Maximum (15 - n) digits. + * + * @param string $national_number + * @deprecated. Instead use setNationalNumber + */ + public function setNational_number($national_number) { + $this->national_number = $national_number; + return $this; + } + /** + * In-country phone number (in E.164 format). Maximum (15 - n) digits. + * + * @return string + * @deprecated. Instead use getNationalNumber + */ + public function getNational_number() { + return $this->national_number; + } + +} diff --git a/lib/PayPal/Api/RedirectUrls.php b/lib/PayPal/Api/RedirectUrls.php index c954b496..42fa9705 100644 --- a/lib/PayPal/Api/RedirectUrls.php +++ b/lib/PayPal/Api/RedirectUrls.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class RedirectUrls extends PPModel { /** * Url where the payer would be redirected to after approving the payment. + * * @param string $return_url */ public function setReturnUrl($return_url) { @@ -15,6 +17,7 @@ public function setReturnUrl($return_url) { /** * Url where the payer would be redirected to after approving the payment. + * * @return string */ public function getReturnUrl() { @@ -23,6 +26,7 @@ public function getReturnUrl() { /** * Url where the payer would be redirected to after approving the payment. + * * @param string $return_url * @deprecated. Instead use setReturnUrl */ @@ -32,6 +36,7 @@ public function setReturn_url($return_url) { } /** * Url where the payer would be redirected to after approving the payment. + * * @return string * @deprecated. Instead use getReturnUrl */ @@ -41,6 +46,7 @@ public function getReturn_url() { /** * Url where the payer would be redirected to after canceling the payment. + * * @param string $cancel_url */ public function setCancelUrl($cancel_url) { @@ -50,6 +56,7 @@ public function setCancelUrl($cancel_url) { /** * Url where the payer would be redirected to after canceling the payment. + * * @return string */ public function getCancelUrl() { @@ -58,6 +65,7 @@ public function getCancelUrl() { /** * Url where the payer would be redirected to after canceling the payment. + * * @param string $cancel_url * @deprecated. Instead use setCancelUrl */ @@ -67,6 +75,7 @@ public function setCancel_url($cancel_url) { } /** * Url where the payer would be redirected to after canceling the payment. + * * @return string * @deprecated. Instead use getCancelUrl */ diff --git a/lib/PayPal/Api/Refund.php b/lib/PayPal/Api/Refund.php index 095200a1..1239885d 100644 --- a/lib/PayPal/Api/Refund.php +++ b/lib/PayPal/Api/Refund.php @@ -2,10 +2,8 @@ namespace PayPal\Api; use PayPal\Common\PPModel; -use PayPal\Rest\IResource; -use PayPal\Rest\Call; use PayPal\Rest\ApiContext; -use PayPal\Api\Refund; +use PayPal\Rest\IResource; use PayPal\Transport\PPRestCall; class Refund extends PPModel implements IResource { @@ -22,6 +20,7 @@ public static function setCredential($credential) { /** * Identifier of the refund transaction. + * * @param string $id */ public function setId($id) { @@ -31,6 +30,7 @@ public function setId($id) { /** * Identifier of the refund transaction. + * * @return string */ public function getId() { @@ -40,6 +40,7 @@ public function getId() { /** * Time the resource was created. + * * @param string $create_time */ public function setCreateTime($create_time) { @@ -49,6 +50,7 @@ public function setCreateTime($create_time) { /** * Time the resource was created. + * * @return string */ public function getCreateTime() { @@ -57,6 +59,7 @@ public function getCreateTime() { /** * Time the resource was created. + * * @param string $create_time * @deprecated. Instead use setCreateTime */ @@ -66,6 +69,7 @@ public function setCreate_time($create_time) { } /** * Time the resource was created. + * * @return string * @deprecated. Instead use getCreateTime */ @@ -73,8 +77,48 @@ public function getCreate_time() { return $this->create_time; } + /** + * Time the resource was last updated. + * + * @param string $update_time + */ + public function setUpdateTime($update_time) { + $this->update_time = $update_time; + return $this; + } + + /** + * Time the resource was last updated. + * + * @return string + */ + public function getUpdateTime() { + return $this->update_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; + } + /** * 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) { @@ -84,6 +128,7 @@ public function setAmount($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() { @@ -93,6 +138,7 @@ public function getAmount() { /** * State of the refund transaction. + * * @param string $state */ public function setState($state) { @@ -102,6 +148,7 @@ public function setState($state) { /** * State of the refund transaction. + * * @return string */ public function getState() { @@ -111,6 +158,7 @@ public function getState() { /** * ID of the Sale transaction being refunded. + * * @param string $sale_id */ public function setSaleId($sale_id) { @@ -120,6 +168,7 @@ public function setSaleId($sale_id) { /** * ID of the Sale transaction being refunded. + * * @return string */ public function getSaleId() { @@ -128,6 +177,7 @@ public function getSaleId() { /** * ID of the Sale transaction being refunded. + * * @param string $sale_id * @deprecated. Instead use setSaleId */ @@ -137,6 +187,7 @@ public function setSale_id($sale_id) { } /** * ID of the Sale transaction being refunded. + * * @return string * @deprecated. Instead use getSaleId */ @@ -146,6 +197,7 @@ public function getSale_id() { /** * ID of the Capture transaction being refunded. + * * @param string $capture_id */ public function setCaptureId($capture_id) { @@ -155,6 +207,7 @@ public function setCaptureId($capture_id) { /** * ID of the Capture transaction being refunded. + * * @return string */ public function getCaptureId() { @@ -163,6 +216,7 @@ public function getCaptureId() { /** * ID of the Capture transaction being refunded. + * * @param string $capture_id * @deprecated. Instead use setCaptureId */ @@ -172,6 +226,7 @@ public function setCapture_id($capture_id) { } /** * ID of the Capture transaction being refunded. + * * @return string * @deprecated. Instead use getCaptureId */ @@ -181,6 +236,7 @@ public function getCapture_id() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment */ public function setParentPayment($parent_payment) { @@ -190,6 +246,7 @@ public function setParentPayment($parent_payment) { /** * ID of the Payment resource that this transaction is based on. + * * @return string */ public function getParentPayment() { @@ -198,6 +255,7 @@ public function getParentPayment() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment * @deprecated. Instead use setParentPayment */ @@ -207,6 +265,7 @@ public function setParent_payment($parent_payment) { } /** * ID of the Payment resource that this transaction is based on. + * * @return string * @deprecated. Instead use getParentPayment */ @@ -216,6 +275,7 @@ public function getParent_payment() { /** * + * * @array * @param PayPal\Api\Links $links */ @@ -226,6 +286,7 @@ public function setLinks($links) { /** * + * * @return PayPal\Api\Links */ public function getLinks() { @@ -234,6 +295,13 @@ public function getLinks() { + /* + * 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"); diff --git a/lib/PayPal/Api/RefundDetail.php b/lib/PayPal/Api/RefundDetail.php new file mode 100644 index 00000000..f659a433 --- /dev/null +++ b/lib/PayPal/Api/RefundDetail.php @@ -0,0 +1,68 @@ +type = $type; + return $this; + } + + /** + * PayPal refund type indicating whether refund was done in invoicing flow via PayPal or externally. In the case of the mark-as-refunded API, refund type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility. + * + * @return string + */ + public function getType() { + return $this->type; + } + + + /** + * Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date. + * + * @param string $date + */ + public function setDate($date) { + $this->date = $date; + return $this; + } + + /** + * Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date. + * + * @return string + */ + public function getDate() { + return $this->date; + } + + + /** + * Optional note associated with the refund. + * + * @param string $note + */ + public function setNote($note) { + $this->note = $note; + return $this; + } + + /** + * Optional note associated with the refund. + * + * @return string + */ + public function getNote() { + return $this->note; + } + + +} diff --git a/lib/PayPal/Api/RelatedResources.php b/lib/PayPal/Api/RelatedResources.php index 7e97776c..c10dafcb 100644 --- a/lib/PayPal/Api/RelatedResources.php +++ b/lib/PayPal/Api/RelatedResources.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class RelatedResources extends PPModel { /** * A sale transaction + * * @param PayPal\Api\Sale $sale */ public function setSale($sale) { @@ -15,6 +17,7 @@ public function setSale($sale) { /** * A sale transaction + * * @return PayPal\Api\Sale */ public function getSale() { @@ -24,6 +27,7 @@ public function getSale() { /** * An authorization transaction + * * @param PayPal\Api\Authorization $authorization */ public function setAuthorization($authorization) { @@ -33,6 +37,7 @@ public function setAuthorization($authorization) { /** * An authorization transaction + * * @return PayPal\Api\Authorization */ public function getAuthorization() { @@ -42,6 +47,7 @@ public function getAuthorization() { /** * A capture transaction + * * @param PayPal\Api\Capture $capture */ public function setCapture($capture) { @@ -51,6 +57,7 @@ public function setCapture($capture) { /** * A capture transaction + * * @return PayPal\Api\Capture */ public function getCapture() { @@ -60,6 +67,7 @@ public function getCapture() { /** * A refund transaction + * * @param PayPal\Api\Refund $refund */ public function setRefund($refund) { @@ -69,6 +77,7 @@ public function setRefund($refund) { /** * A refund transaction + * * @return PayPal\Api\Refund */ public function getRefund() { diff --git a/lib/PayPal/Api/Sale.php b/lib/PayPal/Api/Sale.php index 5fb1284e..2008d208 100644 --- a/lib/PayPal/Api/Sale.php +++ b/lib/PayPal/Api/Sale.php @@ -2,10 +2,8 @@ namespace PayPal\Api; use PayPal\Common\PPModel; -use PayPal\Rest\IResource; -use PayPal\Rest\Call; use PayPal\Rest\ApiContext; -use PayPal\Api\Sale; +use PayPal\Rest\IResource; use PayPal\Api\Refund; use PayPal\Transport\PPRestCall; @@ -23,6 +21,7 @@ public static function setCredential($credential) { /** * Identifier of the authorization transaction. + * * @param string $id */ public function setId($id) { @@ -32,6 +31,7 @@ public function setId($id) { /** * Identifier of the authorization transaction. + * * @return string */ public function getId() { @@ -41,6 +41,7 @@ public function getId() { /** * Time the resource was created. + * * @param string $create_time */ public function setCreateTime($create_time) { @@ -50,6 +51,7 @@ public function setCreateTime($create_time) { /** * Time the resource was created. + * * @return string */ public function getCreateTime() { @@ -58,6 +60,7 @@ public function getCreateTime() { /** * Time the resource was created. + * * @param string $create_time * @deprecated. Instead use setCreateTime */ @@ -67,6 +70,7 @@ public function setCreate_time($create_time) { } /** * Time the resource was created. + * * @return string * @deprecated. Instead use getCreateTime */ @@ -76,6 +80,7 @@ public function getCreate_time() { /** * Time the resource was last updated. + * * @param string $update_time */ public function setUpdateTime($update_time) { @@ -85,6 +90,7 @@ public function setUpdateTime($update_time) { /** * Time the resource was last updated. + * * @return string */ public function getUpdateTime() { @@ -93,6 +99,7 @@ public function getUpdateTime() { /** * Time the resource was last updated. + * * @param string $update_time * @deprecated. Instead use setUpdateTime */ @@ -102,6 +109,7 @@ public function setUpdate_time($update_time) { } /** * Time the resource was last updated. + * * @return string * @deprecated. Instead use getUpdateTime */ @@ -111,6 +119,7 @@ public function getUpdate_time() { /** * Amount being collected. + * * @param PayPal\Api\Amount $amount */ public function setAmount($amount) { @@ -120,6 +129,7 @@ public function setAmount($amount) { /** * Amount being collected. + * * @return PayPal\Api\Amount */ public function getAmount() { @@ -129,6 +139,7 @@ public function getAmount() { /** * State of the sale transaction. + * * @param string $state */ public function setState($state) { @@ -138,6 +149,7 @@ public function setState($state) { /** * State of the sale transaction. + * * @return string */ public function getState() { @@ -147,6 +159,7 @@ public function getState() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment */ public function setParentPayment($parent_payment) { @@ -156,6 +169,7 @@ public function setParentPayment($parent_payment) { /** * ID of the Payment resource that this transaction is based on. + * * @return string */ public function getParentPayment() { @@ -164,6 +178,7 @@ public function getParentPayment() { /** * ID of the Payment resource that this transaction is based on. + * * @param string $parent_payment * @deprecated. Instead use setParentPayment */ @@ -173,6 +188,7 @@ public function setParent_payment($parent_payment) { } /** * ID of the Payment resource that this transaction is based on. + * * @return string * @deprecated. Instead use getParentPayment */ @@ -182,6 +198,7 @@ public function getParent_payment() { /** * + * * @array * @param PayPal\Api\Links $links */ @@ -192,6 +209,7 @@ public function setLinks($links) { /** * + * * @return PayPal\Api\Links */ public function getLinks() { @@ -200,6 +218,13 @@ public function getLinks() { + /* + * 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"); @@ -215,6 +240,13 @@ public static function get($saleId, $apiContext = null) { return $ret; } + /* + * 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"); diff --git a/lib/PayPal/Api/Search.php b/lib/PayPal/Api/Search.php new file mode 100644 index 00000000..5985e282 --- /dev/null +++ b/lib/PayPal/Api/Search.php @@ -0,0 +1,673 @@ +email = $email; + return $this; + } + + /** + * Initial letters of the email address. + * + * @return string + */ + public function getEmail() { + return $this->email; + } + + + /** + * Initial letters of the recipient's first name. + * + * @param string $recipient_first_name + */ + public function setRecipientFirstName($recipient_first_name) { + $this->recipient_first_name = $recipient_first_name; + return $this; + } + + /** + * Initial letters of the recipient's first name. + * + * @return string + */ + public function getRecipientFirstName() { + return $this->recipient_first_name; + } + + /** + * Initial letters of the recipient's first name. + * + * @param string $recipient_first_name + * @deprecated. Instead use setRecipientFirstName + */ + public function setRecipient_first_name($recipient_first_name) { + $this->recipient_first_name = $recipient_first_name; + return $this; + } + /** + * Initial letters of the recipient's first name. + * + * @return string + * @deprecated. Instead use getRecipientFirstName + */ + public function getRecipient_first_name() { + return $this->recipient_first_name; + } + + /** + * Initial letters of the recipient's last name. + * + * @param string $recipient_last_name + */ + public function setRecipientLastName($recipient_last_name) { + $this->recipient_last_name = $recipient_last_name; + return $this; + } + + /** + * Initial letters of the recipient's last name. + * + * @return string + */ + public function getRecipientLastName() { + return $this->recipient_last_name; + } + + /** + * Initial letters of the recipient's last name. + * + * @param string $recipient_last_name + * @deprecated. Instead use setRecipientLastName + */ + public function setRecipient_last_name($recipient_last_name) { + $this->recipient_last_name = $recipient_last_name; + return $this; + } + /** + * Initial letters of the recipient's last name. + * + * @return string + * @deprecated. Instead use getRecipientLastName + */ + public function getRecipient_last_name() { + return $this->recipient_last_name; + } + + /** + * Initial letters of the recipient's business name. + * + * @param string $recipient_business_name + */ + public function setRecipientBusinessName($recipient_business_name) { + $this->recipient_business_name = $recipient_business_name; + return $this; + } + + /** + * Initial letters of the recipient's business name. + * + * @return string + */ + public function getRecipientBusinessName() { + return $this->recipient_business_name; + } + + /** + * Initial letters of the recipient's business name. + * + * @param string $recipient_business_name + * @deprecated. Instead use setRecipientBusinessName + */ + public function setRecipient_business_name($recipient_business_name) { + $this->recipient_business_name = $recipient_business_name; + return $this; + } + /** + * Initial letters of the recipient's business name. + * + * @return string + * @deprecated. Instead use getRecipientBusinessName + */ + public function getRecipient_business_name() { + return $this->recipient_business_name; + } + + /** + * The invoice number that appears on the invoice. + * + * @param string $number + */ + public function setNumber($number) { + $this->number = $number; + return $this; + } + + /** + * The invoice number that appears on the invoice. + * + * @return string + */ + public function getNumber() { + return $this->number; + } + + + /** + * Status of the invoice. + * + * @param string $status + */ + public function setStatus($status) { + $this->status = $status; + return $this; + } + + /** + * Status of the invoice. + * + * @return string + */ + public function getStatus() { + return $this->status; + } + + + /** + * Lower limit of total amount. + * + * @param PayPal\Api\Currency $lower_total_amount + */ + public function setLowerTotalAmount($lower_total_amount) { + $this->lower_total_amount = $lower_total_amount; + return $this; + } + + /** + * Lower limit of total amount. + * + * @return PayPal\Api\Currency + */ + public function getLowerTotalAmount() { + return $this->lower_total_amount; + } + + /** + * Lower limit of total amount. + * + * @param PayPal\Api\Currency $lower_total_amount + * @deprecated. Instead use setLowerTotalAmount + */ + public function setLower_total_amount($lower_total_amount) { + $this->lower_total_amount = $lower_total_amount; + return $this; + } + /** + * Lower limit of total amount. + * + * @return PayPal\Api\Currency + * @deprecated. Instead use getLowerTotalAmount + */ + public function getLower_total_amount() { + return $this->lower_total_amount; + } + + /** + * Upper limit of total amount. + * + * @param PayPal\Api\Currency $upper_total_amount + */ + public function setUpperTotalAmount($upper_total_amount) { + $this->upper_total_amount = $upper_total_amount; + return $this; + } + + /** + * Upper limit of total amount. + * + * @return PayPal\Api\Currency + */ + public function getUpperTotalAmount() { + return $this->upper_total_amount; + } + + /** + * Upper limit of total amount. + * + * @param PayPal\Api\Currency $upper_total_amount + * @deprecated. Instead use setUpperTotalAmount + */ + public function setUpper_total_amount($upper_total_amount) { + $this->upper_total_amount = $upper_total_amount; + return $this; + } + /** + * Upper limit of total amount. + * + * @return PayPal\Api\Currency + * @deprecated. Instead use getUpperTotalAmount + */ + public function getUpper_total_amount() { + return $this->upper_total_amount; + } + + /** + * Start invoice date. + * + * @param string $start_invoice_date + */ + public function setStartInvoiceDate($start_invoice_date) { + $this->start_invoice_date = $start_invoice_date; + return $this; + } + + /** + * Start invoice date. + * + * @return string + */ + public function getStartInvoiceDate() { + return $this->start_invoice_date; + } + + /** + * Start invoice date. + * + * @param string $start_invoice_date + * @deprecated. Instead use setStartInvoiceDate + */ + public function setStart_invoice_date($start_invoice_date) { + $this->start_invoice_date = $start_invoice_date; + return $this; + } + /** + * Start invoice date. + * + * @return string + * @deprecated. Instead use getStartInvoiceDate + */ + public function getStart_invoice_date() { + return $this->start_invoice_date; + } + + /** + * End invoice date. + * + * @param string $end_invoice_date + */ + public function setEndInvoiceDate($end_invoice_date) { + $this->end_invoice_date = $end_invoice_date; + return $this; + } + + /** + * End invoice date. + * + * @return string + */ + public function getEndInvoiceDate() { + return $this->end_invoice_date; + } + + /** + * End invoice date. + * + * @param string $end_invoice_date + * @deprecated. Instead use setEndInvoiceDate + */ + public function setEnd_invoice_date($end_invoice_date) { + $this->end_invoice_date = $end_invoice_date; + return $this; + } + /** + * End invoice date. + * + * @return string + * @deprecated. Instead use getEndInvoiceDate + */ + public function getEnd_invoice_date() { + return $this->end_invoice_date; + } + + /** + * Start invoice due date. + * + * @param string $start_due_date + */ + public function setStartDueDate($start_due_date) { + $this->start_due_date = $start_due_date; + return $this; + } + + /** + * Start invoice due date. + * + * @return string + */ + public function getStartDueDate() { + return $this->start_due_date; + } + + /** + * Start invoice due date. + * + * @param string $start_due_date + * @deprecated. Instead use setStartDueDate + */ + public function setStart_due_date($start_due_date) { + $this->start_due_date = $start_due_date; + return $this; + } + /** + * Start invoice due date. + * + * @return string + * @deprecated. Instead use getStartDueDate + */ + public function getStart_due_date() { + return $this->start_due_date; + } + + /** + * End invoice due date. + * + * @param string $end_due_date + */ + public function setEndDueDate($end_due_date) { + $this->end_due_date = $end_due_date; + return $this; + } + + /** + * End invoice due date. + * + * @return string + */ + public function getEndDueDate() { + return $this->end_due_date; + } + + /** + * End invoice due date. + * + * @param string $end_due_date + * @deprecated. Instead use setEndDueDate + */ + public function setEnd_due_date($end_due_date) { + $this->end_due_date = $end_due_date; + return $this; + } + /** + * End invoice due date. + * + * @return string + * @deprecated. Instead use getEndDueDate + */ + public function getEnd_due_date() { + return $this->end_due_date; + } + + /** + * Start invoice payment date. + * + * @param string $start_payment_date + */ + public function setStartPaymentDate($start_payment_date) { + $this->start_payment_date = $start_payment_date; + return $this; + } + + /** + * Start invoice payment date. + * + * @return string + */ + public function getStartPaymentDate() { + return $this->start_payment_date; + } + + /** + * Start invoice payment date. + * + * @param string $start_payment_date + * @deprecated. Instead use setStartPaymentDate + */ + public function setStart_payment_date($start_payment_date) { + $this->start_payment_date = $start_payment_date; + return $this; + } + /** + * Start invoice payment date. + * + * @return string + * @deprecated. Instead use getStartPaymentDate + */ + public function getStart_payment_date() { + return $this->start_payment_date; + } + + /** + * End invoice payment date. + * + * @param string $end_payment_date + */ + public function setEndPaymentDate($end_payment_date) { + $this->end_payment_date = $end_payment_date; + return $this; + } + + /** + * End invoice payment date. + * + * @return string + */ + public function getEndPaymentDate() { + return $this->end_payment_date; + } + + /** + * End invoice payment date. + * + * @param string $end_payment_date + * @deprecated. Instead use setEndPaymentDate + */ + public function setEnd_payment_date($end_payment_date) { + $this->end_payment_date = $end_payment_date; + return $this; + } + /** + * End invoice payment date. + * + * @return string + * @deprecated. Instead use getEndPaymentDate + */ + public function getEnd_payment_date() { + return $this->end_payment_date; + } + + /** + * Start invoice creation date. + * + * @param string $start_creation_date + */ + public function setStartCreationDate($start_creation_date) { + $this->start_creation_date = $start_creation_date; + return $this; + } + + /** + * Start invoice creation date. + * + * @return string + */ + public function getStartCreationDate() { + return $this->start_creation_date; + } + + /** + * Start invoice creation date. + * + * @param string $start_creation_date + * @deprecated. Instead use setStartCreationDate + */ + public function setStart_creation_date($start_creation_date) { + $this->start_creation_date = $start_creation_date; + return $this; + } + /** + * Start invoice creation date. + * + * @return string + * @deprecated. Instead use getStartCreationDate + */ + public function getStart_creation_date() { + return $this->start_creation_date; + } + + /** + * End invoice creation date. + * + * @param string $end_creation_date + */ + public function setEndCreationDate($end_creation_date) { + $this->end_creation_date = $end_creation_date; + return $this; + } + + /** + * End invoice creation date. + * + * @return string + */ + public function getEndCreationDate() { + return $this->end_creation_date; + } + + /** + * End invoice creation date. + * + * @param string $end_creation_date + * @deprecated. Instead use setEndCreationDate + */ + public function setEnd_creation_date($end_creation_date) { + $this->end_creation_date = $end_creation_date; + return $this; + } + /** + * End invoice creation date. + * + * @return string + * @deprecated. Instead use getEndCreationDate + */ + public function getEnd_creation_date() { + return $this->end_creation_date; + } + + /** + * Offset of the search results. + * + * @param PayPal\Api\number $page + */ + public function setPage($page) { + $this->page = $page; + return $this; + } + + /** + * Offset of the search results. + * + * @return PayPal\Api\number + */ + public function getPage() { + return $this->page; + } + + + /** + * Page size of the search results. + * + * @param PayPal\Api\number $page_size + */ + public function setPageSize($page_size) { + $this->page_size = $page_size; + return $this; + } + + /** + * Page size of the search results. + * + * @return PayPal\Api\number + */ + public function getPageSize() { + return $this->page_size; + } + + /** + * Page size of the search results. + * + * @param PayPal\Api\number $page_size + * @deprecated. Instead use setPageSize + */ + public function setPage_size($page_size) { + $this->page_size = $page_size; + return $this; + } + /** + * Page size of the search results. + * + * @return PayPal\Api\number + * @deprecated. Instead use getPageSize + */ + public function getPage_size() { + return $this->page_size; + } + + /** + * A flag indicating whether total count is required in the response. + * + * @param boolean $total_count_required + */ + public function setTotalCountRequired($total_count_required) { + $this->total_count_required = $total_count_required; + return $this; + } + + /** + * A flag indicating whether total count is required in the response. + * + * @return boolean + */ + public function getTotalCountRequired() { + return $this->total_count_required; + } + + /** + * A flag indicating whether total count is required in the response. + * + * @param boolean $total_count_required + * @deprecated. Instead use setTotalCountRequired + */ + public function setTotal_count_required($total_count_required) { + $this->total_count_required = $total_count_required; + return $this; + } + /** + * A flag indicating whether total count is required in the response. + * + * @return boolean + * @deprecated. Instead use getTotalCountRequired + */ + public function getTotal_count_required() { + return $this->total_count_required; + } + +} diff --git a/lib/PayPal/Api/ShippingAddress.php b/lib/PayPal/Api/ShippingAddress.php index a7f4de94..7bbc1dc4 100644 --- a/lib/PayPal/Api/ShippingAddress.php +++ b/lib/PayPal/Api/ShippingAddress.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class ShippingAddress extends Address { /** * Name of the recipient at this address. + * * @param string $recipient_name */ public function setRecipientName($recipient_name) { @@ -15,6 +17,7 @@ public function setRecipientName($recipient_name) { /** * Name of the recipient at this address. + * * @return string */ public function getRecipientName() { @@ -23,6 +26,7 @@ public function getRecipientName() { /** * Name of the recipient at this address. + * * @param string $recipient_name * @deprecated. Instead use setRecipientName */ @@ -32,6 +36,7 @@ public function setRecipient_name($recipient_name) { } /** * Name of the recipient at this address. + * * @return string * @deprecated. Instead use getRecipientName */ diff --git a/lib/PayPal/Api/ShippingCost.php b/lib/PayPal/Api/ShippingCost.php new file mode 100644 index 00000000..c9e711cb --- /dev/null +++ b/lib/PayPal/Api/ShippingCost.php @@ -0,0 +1,48 @@ +amount = $amount; + return $this; + } + + /** + * Shipping cost in amount. Range of 0 to 999999.99. + * + * @return PayPal\Api\Currency + */ + public function getAmount() { + return $this->amount; + } + + + /** + * Tax percentage on shipping amount. + * + * @param PayPal\Api\Tax $tax + */ + public function setTax($tax) { + $this->tax = $tax; + return $this; + } + + /** + * Tax percentage on shipping amount. + * + * @return PayPal\Api\Tax + */ + public function getTax() { + return $this->tax; + } + + +} diff --git a/lib/PayPal/Api/ShippingInfo.php b/lib/PayPal/Api/ShippingInfo.php new file mode 100644 index 00000000..267816dc --- /dev/null +++ b/lib/PayPal/Api/ShippingInfo.php @@ -0,0 +1,165 @@ +first_name = $first_name; + return $this; + } + + /** + * First name of the invoice recipient. 30 characters max. + * + * @return string + */ + public function getFirstName() { + return $this->first_name; + } + + /** + * First name of the invoice recipient. 30 characters max. + * + * @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 invoice recipient. 30 characters max. + * + * @return string + * @deprecated. Instead use getFirstName + */ + public function getFirst_name() { + return $this->first_name; + } + + /** + * Last name of the invoice recipient. 30 characters max. + * + * @param string $last_name + */ + public function setLastName($last_name) { + $this->last_name = $last_name; + return $this; + } + + /** + * Last name of the invoice recipient. 30 characters max. + * + * @return string + */ + public function getLastName() { + return $this->last_name; + } + + /** + * Last name of the invoice recipient. 30 characters max. + * + * @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 invoice recipient. 30 characters max. + * + * @return string + * @deprecated. Instead use getLastName + */ + public function getLast_name() { + return $this->last_name; + } + + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @param string $business_name + */ + public function setBusinessName($business_name) { + $this->business_name = $business_name; + return $this; + } + + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @return string + */ + public function getBusinessName() { + return $this->business_name; + } + + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @param string $business_name + * @deprecated. Instead use setBusinessName + */ + public function setBusiness_name($business_name) { + $this->business_name = $business_name; + return $this; + } + /** + * Company business name of the invoice recipient. 100 characters max. + * + * @return string + * @deprecated. Instead use getBusinessName + */ + public function getBusiness_name() { + return $this->business_name; + } + + /** + * + * + * @param PayPal\Api\Phone $phone + */ + public function setPhone($phone) { + $this->phone = $phone; + return $this; + } + + /** + * + * + * @return PayPal\Api\Phone + */ + public function getPhone() { + return $this->phone; + } + + + /** + * Address of the invoice recipient. + * + * @param PayPal\Api\Address $address + */ + public function setAddress($address) { + $this->address = $address; + return $this; + } + + /** + * Address of the invoice recipient. + * + * @return PayPal\Api\Address + */ + public function getAddress() { + return $this->address; + } + + +} diff --git a/lib/PayPal/Api/Tax.php b/lib/PayPal/Api/Tax.php new file mode 100644 index 00000000..60c73ea7 --- /dev/null +++ b/lib/PayPal/Api/Tax.php @@ -0,0 +1,88 @@ +id = $id; + return $this; + } + + /** + * Identifier of the resource. + * + * @return string + */ + public function getId() { + return $this->id; + } + + + /** + * Name of the tax. 10 characters max. + * + * @param string $name + */ + public function setName($name) { + $this->name = $name; + return $this; + } + + /** + * Name of the tax. 10 characters max. + * + * @return string + */ + public function getName() { + return $this->name; + } + + + /** + * Rate of the specified tax. Range of 0.001 to 99.999. + * + * @param PayPal\Api\number $percent + */ + public function setPercent($percent) { + $this->percent = $percent; + return $this; + } + + /** + * Rate of the specified tax. Range of 0.001 to 99.999. + * + * @return PayPal\Api\number + */ + public function getPercent() { + return $this->percent; + } + + + /** + * Tax in the form of money. Cannot be specified in a request. + * + * @param PayPal\Api\Currency $amount + */ + public function setAmount($amount) { + $this->amount = $amount; + return $this; + } + + /** + * Tax in the form of money. Cannot be specified in a request. + * + * @return PayPal\Api\Currency + */ + public function getAmount() { + return $this->amount; + } + + +} diff --git a/lib/PayPal/Api/Transaction.php b/lib/PayPal/Api/Transaction.php index d8420aa0..2f4e3b9e 100644 --- a/lib/PayPal/Api/Transaction.php +++ b/lib/PayPal/Api/Transaction.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Transaction extends PPModel { /** * Amount being collected. + * * @param PayPal\Api\Amount $amount */ public function setAmount($amount) { @@ -15,6 +17,7 @@ public function setAmount($amount) { /** * Amount being collected. + * * @return PayPal\Api\Amount */ public function getAmount() { @@ -24,6 +27,7 @@ public function getAmount() { /** * Recepient of the funds in this transaction. + * * @param PayPal\Api\Payee $payee */ public function setPayee($payee) { @@ -33,6 +37,7 @@ public function setPayee($payee) { /** * Recepient of the funds in this transaction. + * * @return PayPal\Api\Payee */ public function getPayee() { @@ -42,6 +47,7 @@ public function getPayee() { /** * Description of what is being paid for. + * * @param string $description */ public function setDescription($description) { @@ -51,6 +57,7 @@ public function setDescription($description) { /** * Description of what is being paid for. + * * @return string */ public function getDescription() { @@ -60,6 +67,7 @@ public function getDescription() { /** * List of items being paid for. + * * @param PayPal\Api\ItemList $item_list */ public function setItemList($item_list) { @@ -69,6 +77,7 @@ public function setItemList($item_list) { /** * List of items being paid for. + * * @return PayPal\Api\ItemList */ public function getItemList() { @@ -77,6 +86,7 @@ public function getItemList() { /** * List of items being paid for. + * * @param PayPal\Api\ItemList $item_list * @deprecated. Instead use setItemList */ @@ -86,6 +96,7 @@ public function setItem_list($item_list) { } /** * List of items being paid for. + * * @return PayPal\Api\ItemList * @deprecated. Instead use getItemList */ @@ -95,6 +106,7 @@ public function getItem_list() { /** * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. + * * @array * @param PayPal\Api\RelatedResources $related_resources */ @@ -105,6 +117,7 @@ public function setRelatedResources($related_resources) { /** * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. + * * @return PayPal\Api\RelatedResources */ public function getRelatedResources() { @@ -113,6 +126,7 @@ public function getRelatedResources() { /** * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. + * * @array * @param PayPal\Api\RelatedResources $related_resources * @deprecated. Instead use setRelatedResources @@ -123,6 +137,7 @@ public function setRelated_resources($related_resources) { } /** * List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. + * * @return PayPal\Api\RelatedResources * @deprecated. Instead use getRelatedResources */ @@ -132,6 +147,7 @@ public function getRelated_resources() { /** * Additional transactions for complex payment (Parallel and Chained) scenarios. + * * @array * @param PayPal\Api\self $transactions */ @@ -142,6 +158,7 @@ public function setTransactions($transactions) { /** * Additional transactions for complex payment (Parallel and Chained) scenarios. + * * @return PayPal\Api\self */ public function getTransactions() { diff --git a/lib/PayPal/Api/Transactions.php b/lib/PayPal/Api/Transactions.php index 22198370..58177904 100644 --- a/lib/PayPal/Api/Transactions.php +++ b/lib/PayPal/Api/Transactions.php @@ -2,10 +2,12 @@ namespace PayPal\Api; use PayPal\Common\PPModel; +use PayPal\Rest\ApiContext; class Transactions extends PPModel { /** * Amount being collected. + * * @param PayPal\Api\Amount $amount */ public function setAmount($amount) { @@ -15,6 +17,7 @@ public function setAmount($amount) { /** * Amount being collected. + * * @return PayPal\Api\Amount */ public function getAmount() { diff --git a/release_notes.md b/release_notes.md new file mode 100644 index 00000000..3bd67e01 --- /dev/null +++ b/release_notes.md @@ -0,0 +1,25 @@ +PayPal PHP SDK release notes +============================ + +v0.8.0 +----- +* Invoicing API support added + +v0.7.1 +----- +* Added support for Reauthorization + +v0.7.0 +----- +* Added support for Auth and Capture APIs +* Types modified to match the API Spec +* Updated SDK to use namespace supported core library + +v0.6.0 +----- +* Adding support for dynamic configuration of SDK (Upgrading sdk-core-php dependency to V1.4.0) +* Deprecating the setCredential method and changing resource class methods to take an ApiContext argument instead of a OauthTokenCredential argument. + +v0.5.0 +----- +* Initial Release \ No newline at end of file diff --git a/sample/composer.json b/sample/composer.json index 0231328b..a743c50b 100644 --- a/sample/composer.json +++ b/sample/composer.json @@ -9,6 +9,6 @@ "php": ">=5.3.0", "ext-curl": "*", "ext-json": "*", - "paypal/rest-api-sdk-php" : "0.7.*" + "paypal/rest-api-sdk-php" : "0.8.*" } } diff --git a/sample/invoicing/CancelInvoice.php b/sample/invoicing/CancelInvoice.php new file mode 100644 index 00000000..5abefd6f --- /dev/null +++ b/sample/invoicing/CancelInvoice.php @@ -0,0 +1,37 @@ +setSubject("Past due") + ->setNote("Canceling invoice") + ->setSendToMerchant(true) + ->setSendToPayer(true); + + + $cancelStatus = $invoice->cancel($notify, $apiContext); +} catch (PayPal\Exception\PPConnectionException $ex) { + echo "Exception: " . $ex->getMessage() . PHP_EOL; + var_dump($ex->getData()); + exit(1); +} + +?> + + + + Cancel Invoice + + +
Cancel Invoice:
+
+ Back + + diff --git a/sample/invoicing/CreateInvoice.php b/sample/invoicing/CreateInvoice.php new file mode 100644 index 00000000..e67fcab8 --- /dev/null +++ b/sample/invoicing/CreateInvoice.php @@ -0,0 +1,100 @@ +setMerchantInfo(new MerchantInfo()) + ->setBillingInfo(array(new BillingInfo())) + ->setItems(array(new InvoiceItem())) + ->setNote("Medical Invoice 16 Jul, 2013 PST") + ->setPaymentTerm(new PaymentTerm()) + ->setShippingInfo(new ShippingInfo()); + +$invoice->getMerchantInfo() + ->setEmail("PPX.DevNet-facilitator@gmail.com") + ->setFirstName("Dennis") + ->setLastName("Doctor") + ->setbusinessName("Medical Professionals, LLC") + ->setPhone(new Phone()) + ->setAddress(new Address()); + +$invoice->getMerchantInfo()->getPhone() + ->setCountryCode("001") + ->setNationalNumber("5032141716"); + +$invoice->getMerchantInfo()->getAddress() + ->setLine1("1234 Main St.") + ->setCity("Portland") + ->setState("OR") + ->setPostalCode("97217") + ->setCountryCode("US"); + +$billing = $invoice->getBillingInfo(); +$billing[0] + ->setEmail("example@example.com"); + +$items = $invoice->getItems(); +$items[0] + ->setName("Sutures") + ->setQuantity(100) + ->setUnitPrice(new Currency()); + +$items[0]->getUnitPrice() + ->setCurrency("USD") + ->setValue(5); + +$invoice->getPaymentTerm() + ->setTermType("NET_45"); + +$invoice->getShippingInfo() + ->setFirstName("Sally") + ->setLastName("Patient") + ->setBusinessName("Not applicable") + ->setPhone(new Phone()) + ->setAddress(new Address()); + +$invoice->getShippingInfo()->getPhone() + ->setCountryCode("001") + ->setNationalNumber("5039871234"); + +$invoice->getShippingInfo()->getAddress() + ->setLine1("1234 Main St.") + ->setCity("Portland") + ->setState("OR") + ->setPostalCode("97217") + ->setCountryCode("US"); + +print(var_dump($invoice->toArray())); + +try { + $invoice->create($apiContext); +} catch (PayPal\Exception\PPConnectionException $ex) { + echo "Exception: " . $ex->getMessage() . PHP_EOL; + var_dump($ex->getData()); + exit(1); +} +?> + + + Direct Credit card payments + + +
+ Created Invoice: + getId();?> +
+ 
toArray());?>
+ Back + + diff --git a/sample/invoicing/GetInvoice.php b/sample/invoicing/GetInvoice.php new file mode 100644 index 00000000..3add02c1 --- /dev/null +++ b/sample/invoicing/GetInvoice.php @@ -0,0 +1,19 @@ + + + + Lookup invoice details + + +
Retrieving Invoice:
+
+ Back + + diff --git a/sample/invoicing/ListInvoice.php b/sample/invoicing/ListInvoice.php new file mode 100644 index 00000000..420ebba4 --- /dev/null +++ b/sample/invoicing/ListInvoice.php @@ -0,0 +1,22 @@ +getMessage() . PHP_EOL; + var_dump($ex->getData()); + exit(1); +} +?> + + + Lookup invoice history + + +
Got invoices
+ 
toArray());?>
+ Back + + diff --git a/sample/invoicing/RemindInvoice.php b/sample/invoicing/RemindInvoice.php new file mode 100644 index 00000000..1d20789b --- /dev/null +++ b/sample/invoicing/RemindInvoice.php @@ -0,0 +1,35 @@ +setSubject("Past due") + ->setNote("Please pay soon") + ->setSendToMerchant(true); + + $remindStatus = $invoice->remind($notify, $apiContext); +} catch (PayPal\Exception\PPConnectionException $ex) { + echo "Exception: " . $ex->getMessage() . PHP_EOL; + var_dump($ex->getData()); + exit(1); +} + +?> + + + + Remind Invoice + + +
Remind Invoice:
+
+ Back + + diff --git a/sample/invoicing/SendInvoice.php b/sample/invoicing/SendInvoice.php new file mode 100644 index 00000000..61d39cc8 --- /dev/null +++ b/sample/invoicing/SendInvoice.php @@ -0,0 +1,27 @@ +send($apiContext); +} catch (PayPal\Exception\PPConnectionException $ex) { + echo "Exception: " . $ex->getMessage() . PHP_EOL; + var_dump($ex->getData()); + exit(1); +} + +?> + + + Send Invoice + + +
Send Invoice:
+
+ Back + + diff --git a/tests/PayPal/Test/Api/CreditCardTest.php b/tests/PayPal/Test/Api/CreditCardTest.php index 27896fef..84cb96b1 100644 --- a/tests/PayPal/Test/Api/CreditCardTest.php +++ b/tests/PayPal/Test/Api/CreditCardTest.php @@ -5,9 +5,9 @@ use PayPal\Api\CreditCard; use PayPal\Test\Constants; class CreditCardTest extends \PHPUnit_Framework_TestCase { - + private $cards; - + public static $id = "id"; public static $validUntil = "2013-02-28T00:00:00Z"; public static $state = "created"; @@ -19,7 +19,7 @@ class CreditCardTest extends \PHPUnit_Framework_TestCase { public static $cvv = "012"; public static $firstName = "V"; public static $lastName = "C"; - + public static function createCreditCard() { $card = new CreditCard(); $card->setType(self::$cardType); @@ -29,24 +29,21 @@ public static function createCreditCard() { $card->setCvv2(self::$cvv); $card->setFirstName(self::$firstName); $card->setLastName(self::$lastName); - $card->setId(self::$id); - $card->setValidUntil(self::$validUntil); - $card->setState(self::$state); $card->setPayerId(self::$payerId); return $card; } - + public function setup() { - + $card = self::createCreditCard(); - $card->setBillingAddress(AddressTest::createAddress()); + $card->setBillingAddress(AddressTest::createAddress()); $card->setLinks(array(LinksTest::createLinks())); $this->cards['full'] = $card; - - $card = self::createCreditCard(); + + $card = self::createCreditCard(); $this->cards['partial'] = $card; } - + public function testGetterSetters() { $c = $this->cards['partial']; $this->assertEquals(self::$cardType, $c->getType()); @@ -56,34 +53,32 @@ public function testGetterSetters() { $this->assertEquals(self::$cvv, $c->getCvv2()); $this->assertEquals(self::$firstName, $c->getFirstName()); $this->assertEquals(self::$lastName, $c->getLastName()); - $this->assertEquals(self::$id, $c->getId()); - $this->assertEquals(self::$validUntil, $c->getValidUntil()); - $this->assertEquals(self::$state, $c->getState()); $this->assertEquals(self::$payerId, $c->getPayerId()); - + $c = $this->cards['full']; $this->assertEquals(AddressTest::$line1, $c->getBillingAddress()->getLine1()); $link = $c->getLinks(); $this->assertEquals(LinksTest::$href, $link[0]->getHref()); } - + public function testSerializeDeserialize() { $c1 = $this->cards['full']; $json = $c1->toJson(); - + $c2 = new CreditCard(); - $c2->fromJson($json); - + $c2->fromJson($json); + $this->assertEquals($c1, $c2); } - + public function testOperations() { $c1 = $this->cards['full']; - + // $this->assertNull($c1->getId()); - $c1->create(); + $c1->create(); $this->assertNotNull($c1->getId()); - + + $c2 = CreditCard::get($c1->getId()); $this->assertEquals($c1->getBillingAddress(), $c2->getBillingAddress()); $this->assertGreaterThan(0, count($c2->getLinks())); diff --git a/tests/PayPal/Test/Api/FundingInstrumentTest.php b/tests/PayPal/Test/Api/FundingInstrumentTest.php index cb420d63..d5df08dd 100644 --- a/tests/PayPal/Test/Api/FundingInstrumentTest.php +++ b/tests/PayPal/Test/Api/FundingInstrumentTest.php @@ -15,22 +15,22 @@ public static function createFundingInstrument() { $fi->setCreditCardToken(CreditCardTokenTest::createCreditCardToken()); return $fi; } - + public function setup() { $this->fi = self::createFundingInstrument(); } public function testGetterSetter() { $this->assertEquals(CreditCardTest::$cardNumber, $this->fi->getCreditCard()->getNumber()); - $this->assertEquals(CreditCardTokenTest::$creditCardId, + $this->assertEquals(CreditCardTokenTest::$creditCardId, $this->fi->getCreditCardToken()->getCreditCardId()); } - + public function testSerializeDeserialize() { $fi1 = $this->fi; - + $fi2 = new FundingInstrument(); - $fi2->fromJson($fi1->toJson()); + $fi2->fromJson($fi1->toJson()); $this->assertEquals($fi1, $fi2); } } \ No newline at end of file diff --git a/tests/PayPal/Test/Api/PaymentTest.php b/tests/PayPal/Test/Api/PaymentTest.php index 2bf97955..6e92d237 100644 --- a/tests/PayPal/Test/Api/PaymentTest.php +++ b/tests/PayPal/Test/Api/PaymentTest.php @@ -12,66 +12,70 @@ class PaymentTest extends \PHPUnit_Framework_TestCase { - private $payments; + private $payments; public static function createPayment() { - + $redirectUrls = new RedirectUrls(); $redirectUrls->setReturnUrl("http://localhost/return"); $redirectUrls->setCancelUrl("http://localhost/cancel"); - + $payment = new Payment(); $payment->setIntent("sale"); $payment->setRedirectUrls($redirectUrls); $payment->setPayer(PayerTest::createPayer()); $payment->setTransactions(array(TransactionTest::createTransaction())); - - return $payment; + + return $payment; } - + public static function createNewPayment() { + + $funding = FundingInstrumentTest::createFundingInstrument(); + $funding->credit_card_token = null; + $payer = new Payer(); $payer->setPaymentMethod("credit_card"); - $payer->setFundingInstruments(array(FundingInstrumentTest::createFundingInstrument())); - + $payer->setFundingInstruments(array($funding)); + $transaction = new Transaction(); $transaction->setAmount(AmountTest::createAmount()); $transaction->setDescription("This is the payment description."); - + $redirectUrls = new RedirectUrls(); $redirectUrls->setReturnUrl("http://localhost/return"); $redirectUrls->setCancelUrl("http://localhost/cancel"); - + $payment = new Payment(); $payment->setIntent("sale"); $payment->setRedirectUrls($redirectUrls); $payment->setPayer($payer); $payment->setTransactions(array($transaction)); - - return $payment; + + return $payment; } - - public function setup() { + + public function setup() { $this->payments['full'] = self::createPayment(); $this->payments['new'] = self::createNewPayment(); } - + public function testSerializeDeserialize() { $p2 = new Payment(); - $p2->fromJson($this->payments['full']->toJSON()); + $p2->fromJson($this->payments['full']->toJSON()); $this->assertEquals($p2, $this->payments['full']); } - + public function testOperations() { $p1 = $this->payments['new']; - - $p1->create(); + + $p1->create(); $this->assertNotNull($p1->getId()); - + $p2 = Payment::get($p1->getId()); $this->assertNotNull($p2); - + $paymentHistory = Payment::all(array('count' => '10')); $this->assertNotNull($paymentHistory); }