diff --git a/lib/PayPal/Api/Address.php b/lib/PayPal/Api/Address.php index 39a0c86f..aba5a706 100644 --- a/lib/PayPal/Api/Address.php +++ b/lib/PayPal/Api/Address.php @@ -17,7 +17,7 @@ class Address extends BaseAddress * Phone number in E.123 format. * * @param string $phone - * + * * @return $this */ public function setPhone($phone) diff --git a/lib/PayPal/Api/BillingInfo.php b/lib/PayPal/Api/BillingInfo.php index 3b0a4cdb..57d15eaf 100644 --- a/lib/PayPal/Api/BillingInfo.php +++ b/lib/PayPal/Api/BillingInfo.php @@ -24,7 +24,7 @@ class BillingInfo extends PayPalModel { /** - * Email address of the invoice recipient. 260 characters max. + * The invoice recipient email address. Maximum length is 260 characters. * * @param string $email * @@ -37,7 +37,7 @@ public function setEmail($email) } /** - * Email address of the invoice recipient. 260 characters max. + * The invoice recipient email address. Maximum length is 260 characters. * * @return string */ @@ -47,7 +47,7 @@ public function getEmail() } /** - * First name of the invoice recipient. 30 characters max. + * The invoice recipient first name. Maximum length is 30 characters. * * @param string $first_name * @@ -60,7 +60,7 @@ public function setFirstName($first_name) } /** - * First name of the invoice recipient. 30 characters max. + * The invoice recipient first name. Maximum length is 30 characters. * * @return string */ @@ -70,7 +70,7 @@ public function getFirstName() } /** - * Last name of the invoice recipient. 30 characters max. + * The invoice recipient last name. Maximum length is 30 characters. * * @param string $last_name * @@ -83,7 +83,7 @@ public function setLastName($last_name) } /** - * Last name of the invoice recipient. 30 characters max. + * The invoice recipient last name. Maximum length is 30 characters. * * @return string */ @@ -93,7 +93,7 @@ public function getLastName() } /** - * Company business name of the invoice recipient. 100 characters max. + * The invoice recipient company business name. Maximum length is 100 characters. * * @param string $business_name * @@ -106,7 +106,7 @@ public function setBusinessName($business_name) } /** - * Company business name of the invoice recipient. 100 characters max. + * The invoice recipient company business name. Maximum length is 100 characters. * * @return string */ @@ -116,7 +116,7 @@ public function getBusinessName() } /** - * Address of the invoice recipient. + * The invoice recipient address. * * @param \PayPal\Api\InvoiceAddress $address * @@ -129,7 +129,7 @@ public function setAddress($address) } /** - * Address of the invoice recipient. + * The invoice recipient address. * * @return \PayPal\Api\InvoiceAddress */ @@ -139,8 +139,8 @@ public function getAddress() } /** - * Language of the email sent to the payer. Will only be used if payer doesn't have a PayPal account. - * Valid Values: ["da_DK", "de_DE", "en_AU", "en_GB", "en_US", "es_ES", "es_XC", "fr_CA", "fr_FR", "fr_XC", "he_IL", "id_ID", "it_IT", "ja_JP", "nl_NL", "no_NO", "pl_PL", "pt_BR", "pt_PT", "ru_RU", "sv_SE", "th_TH", "tr_TR", "zh_CN", "zh_HK", "zh_TW", "zh_XC"] + * The language in which the email was sent to the payer. Used only when the payer does not have a PayPal account. + * Valid Values: ["da_DK", "de_DE", "en_AU", "en_GB", "en_US", "es_ES", "es_XC", "fr_CA", "fr_FR", "fr_XC", "he_IL", "id_ID", "it_IT", "ja_JP", "nl_NL", "no_NO", "pl_PL", "pt_BR", "pt_PT", "ru_RU", "sv_SE", "th_TH", "zh_CN", "zh_HK", "zh_TW", "zh_XC"] * * @param string $language * @@ -153,7 +153,7 @@ public function setLanguage($language) } /** - * Language of the email sent to the payer. Will only be used if payer doesn't have a PayPal account. + * The language in which the email was sent to the payer. Used only when the payer does not have a PayPal account. * * @return string */ @@ -163,7 +163,7 @@ public function getLanguage() } /** - * Option to display additional information such as business hours. 40 characters max. + * Additional information, such as business hours. Maximum length is 40 characters. * * @param string $additional_info * @@ -176,7 +176,7 @@ public function setAdditionalInfo($additional_info) } /** - * Option to display additional information such as business hours. 40 characters max. + * Additional information, such as business hours. Maximum length is 40 characters. * * @return string */ diff --git a/lib/PayPal/Api/CancelNotification.php b/lib/PayPal/Api/CancelNotification.php index 612b302d..ccbea45b 100644 --- a/lib/PayPal/Api/CancelNotification.php +++ b/lib/PayPal/Api/CancelNotification.php @@ -15,6 +15,7 @@ * @property string note * @property bool send_to_merchant * @property bool send_to_payer + * @property string[] cc_emails */ class CancelNotification extends PayPalModel { @@ -65,7 +66,7 @@ public function getNote() } /** - * A flag indicating whether a copy of the email has to be sent to the merchant. + * Indicates whether to send a copy of the notification to the merchant. * * @param bool $send_to_merchant * @@ -78,7 +79,7 @@ public function setSendToMerchant($send_to_merchant) } /** - * A flag indicating whether a copy of the email has to be sent to the merchant. + * Indicates whether to send a copy of the notification to the merchant. * * @return bool */ @@ -88,7 +89,7 @@ public function getSendToMerchant() } /** - * A flag indicating whether a copy of the email has to be sent to the payer. + * Indicates whether to send a copy of the notification to the payer. * * @param bool $send_to_payer * @@ -101,7 +102,7 @@ public function setSendToPayer($send_to_payer) } /** - * A flag indicating whether a copy of the email has to be sent to the payer. + * Indicates whether to send a copy of the notification to the payer. * * @return bool */ @@ -110,4 +111,57 @@ public function getSendToPayer() return $this->send_to_payer; } + /** + * Applicable for invoices created with Cc emails. If this field is not in the body, all the cc email addresses added as part of the invoice shall be notified else this field can be used to limit the list of email addresses. Note: additional email addresses are not supported. + * + * @param string[] $cc_emails + * + * @return $this + */ + public function setCcEmails($cc_emails) + { + $this->cc_emails = $cc_emails; + return $this; + } + + /** + * Applicable for invoices created with Cc emails. If this field is not in the body, all the cc email addresses added as part of the invoice shall be notified else this field can be used to limit the list of email addresses. Note: additional email addresses are not supported. + * + * @return string[] + */ + public function getCcEmails() + { + return $this->cc_emails; + } + + /** + * Append CcEmails to the list. + * + * @param string $string + * @return $this + */ + public function addCcEmail($string) + { + if (!$this->getCcEmails()) { + return $this->setCcEmails(array($string)); + } else { + return $this->setCcEmails( + array_merge($this->getCcEmails(), array($string)) + ); + } + } + + /** + * Remove CcEmails from the list. + * + * @param string $string + * @return $this + */ + public function removeCcEmail($string) + { + return $this->setCcEmails( + array_diff($this->getCcEmails(), array($string)) + ); + } + } diff --git a/lib/PayPal/Api/Cost.php b/lib/PayPal/Api/Cost.php index b8fa4ec3..5a96fba6 100644 --- a/lib/PayPal/Api/Cost.php +++ b/lib/PayPal/Api/Cost.php @@ -9,7 +9,7 @@ /** * Class Cost * - * Cost as a percent. For example, 10% should be entered as 10. Alternatively, cost as an amount. For example, an amount of 5 should be entered as 5. + * Cost as a percent or an amount. For example, to specify 10%, enter `10`. Alternatively, to specify an amount of 5, enter `5`. * * @package PayPal\Api * @@ -44,7 +44,7 @@ public function getPercent() } /** - * Cost in amount. Range of 0 to 999999.99. + * The cost, as an amount. Valid range is from 0 to 1,000,000. * * @param \PayPal\Api\Currency $amount * @@ -57,7 +57,7 @@ public function setAmount($amount) } /** - * Cost in amount. Range of 0 to 999999.99. + * The cost, as an amount. Valid range is from 0 to 1,000,000. * * @return \PayPal\Api\Currency */ diff --git a/lib/PayPal/Api/CustomAmount.php b/lib/PayPal/Api/CustomAmount.php index 47f9d75d..e61146c8 100644 --- a/lib/PayPal/Api/CustomAmount.php +++ b/lib/PayPal/Api/CustomAmount.php @@ -7,7 +7,7 @@ /** * Class CustomAmount * - * Custom amount applied on an invoice. If a label is included then the amount cannot be empty. + * The custom amount applied on an invoice. If you include a label, the amount cannot be empty. * * @package PayPal\Api * @@ -17,7 +17,7 @@ class CustomAmount extends PayPalModel { /** - * Custom amount label. 25 characters max. + * The custom amount label. Maximum length is 25 characters. * * @param string $label * @@ -30,7 +30,7 @@ public function setLabel($label) } /** - * Custom amount label. 25 characters max. + * The custom amount label. Maximum length is 25 characters. * * @return string */ @@ -40,7 +40,7 @@ public function getLabel() } /** - * Custom amount value. Range of 0 to 999999.99. + * The custom amount value. Valid range is from -999999.99 to 999999.99. * * @param \PayPal\Api\Currency $amount * @@ -53,7 +53,7 @@ public function setAmount($amount) } /** - * Custom amount value. Range of 0 to 999999.99. + * The custom amount value. Valid range is from -999999.99 to 999999.99. * * @return \PayPal\Api\Currency */ diff --git a/lib/PayPal/Api/ErrorDetails.php b/lib/PayPal/Api/ErrorDetails.php index 2885a2e0..38ed5d11 100644 --- a/lib/PayPal/Api/ErrorDetails.php +++ b/lib/PayPal/Api/ErrorDetails.php @@ -20,7 +20,7 @@ class ErrorDetails extends PayPalModel * Name of the field that caused the error. * * @param string $field - * + * * @return $this */ public function setField($field) @@ -43,7 +43,7 @@ public function getField() * Reason for the error. * * @param string $issue - * + * * @return $this */ public function setIssue($issue) diff --git a/lib/PayPal/Api/FileAttachment.php b/lib/PayPal/Api/FileAttachment.php new file mode 100644 index 00000000..23b9055e --- /dev/null +++ b/lib/PayPal/Api/FileAttachment.php @@ -0,0 +1,67 @@ +name = $name; + return $this; + } + + /** + * Name of the file attached. + * + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * URL of the attached file that can be downloaded. + * + * @param string $url + * @throws \InvalidArgumentException + * @return $this + */ + public function setUrl($url) + { + UrlValidator::validate($url, "Url"); + $this->url = $url; + return $this; + } + + /** + * URL of the attached file that can be downloaded. + * + * @return string + */ + public function getUrl() + { + return $this->url; + } + +} diff --git a/lib/PayPal/Api/Invoice.php b/lib/PayPal/Api/Invoice.php index 1a555482..6db360f8 100644 --- a/lib/PayPal/Api/Invoice.php +++ b/lib/PayPal/Api/Invoice.php @@ -17,18 +17,22 @@ * * @property string id * @property string number + * @property string template_id * @property string uri * @property string status * @property \PayPal\Api\MerchantInfo merchant_info * @property \PayPal\Api\BillingInfo[] billing_info + * @property \PayPal\Api\Participant[] cc_info * @property \PayPal\Api\ShippingInfo shipping_info * @property \PayPal\Api\InvoiceItem[] items * @property string invoice_date * @property \PayPal\Api\PaymentTerm payment_term - * @property String reference + * @property string reference * @property \PayPal\Api\Cost discount * @property \PayPal\Api\ShippingCost shipping_cost * @property \PayPal\Api\CustomAmount custom + * @property bool allow_partial_payment + * @property \PayPal\Api\Currency minimum_amount_due * @property bool tax_calculated_after_discount * @property bool tax_inclusive * @property string terms @@ -39,12 +43,14 @@ * @property \PayPal\Api\PaymentDetail[] payments * @property \PayPal\Api\RefundDetail[] refunds * @property \PayPal\Api\Metadata metadata - * @property string additional_data + * @property \PayPal\Api\PaymentSummary paid_amount + * @property \PayPal\Api\PaymentSummary refunded_amount + * @property \PayPal\Api\FileAttachment[] attachments */ class Invoice extends PayPalResourceModel { /** - * Unique invoice resource identifier. + * The unique invoice resource identifier. * * @param string $id * @@ -57,7 +63,7 @@ public function setId($id) } /** - * Unique invoice resource identifier. + * The unique invoice resource identifier. * * @return string */ @@ -89,6 +95,29 @@ public function getNumber() return $this->number; } + /** + * The template ID used for the invoice. Useful for copy functionality. + * + * @param string $template_id + * + * @return $this + */ + public function setTemplateId($template_id) + { + $this->template_id = $template_id; + return $this; + } + + /** + * The template ID used for the invoice. Useful for copy functionality. + * + * @return string + */ + public function getTemplateId() + { + return $this->template_id; + } + /** * URI of the invoice resource. * @@ -114,7 +143,7 @@ public function getUri() /** * Status of the invoice. - * Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"] + * Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED", "UNPAID", "PAYMENT_PENDING"] * * @param string $status * @@ -160,7 +189,7 @@ public function getMerchantInfo() } /** - * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). + * The required invoice recipient email address and any optional billing information. One recipient is supported. * * @param \PayPal\Api\BillingInfo[] $billing_info * @@ -173,7 +202,7 @@ public function setBillingInfo($billing_info) } /** - * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). + * The required invoice recipient email address and any optional billing information. One recipient is supported. * * @return \PayPal\Api\BillingInfo[] */ @@ -213,7 +242,60 @@ public function removeBillingInfo($billingInfo) } /** - * Shipping information for entities to whom items are being shipped. + * For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant. + * + * @param \PayPal\Api\Participant[] $cc_info + * + * @return $this + */ + public function setCcInfo($cc_info) + { + $this->cc_info = $cc_info; + return $this; + } + + /** + * For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant. + * + * @return \PayPal\Api\Participant[] + */ + public function getCcInfo() + { + return $this->cc_info; + } + + /** + * Append CcInfo to the list. + * + * @param \PayPal\Api\Participant $participant + * @return $this + */ + public function addCcInfo($participant) + { + if (!$this->getCcInfo()) { + return $this->setCcInfo(array($participant)); + } else { + return $this->setCcInfo( + array_merge($this->getCcInfo(), array($participant)) + ); + } + } + + /** + * Remove CcInfo from the list. + * + * @param \PayPal\Api\Participant $participant + * @return $this + */ + public function removeCcInfo($participant) + { + return $this->setCcInfo( + array_diff($this->getCcInfo(), array($participant)) + ); + } + + /** + * The shipping information for entities to whom items are being shipped. * * @param \PayPal\Api\ShippingInfo $shipping_info * @@ -226,7 +308,7 @@ public function setShippingInfo($shipping_info) } /** - * Shipping information for entities to whom items are being shipped. + * The shipping information for entities to whom items are being shipped. * * @return \PayPal\Api\ShippingInfo */ @@ -236,7 +318,7 @@ public function getShippingInfo() } /** - * List of items included in the invoice. 100 items max per invoice. + * The list of items to include in the invoice. Maximum value is 100 items per invoice. * * @param \PayPal\Api\InvoiceItem[] $items * @@ -249,7 +331,7 @@ public function setItems($items) } /** - * List of items included in the invoice. 100 items max per invoice. + * The list of items to include in the invoice. Maximum value is 100 items per invoice. * * @return \PayPal\Api\InvoiceItem[] */ @@ -289,7 +371,7 @@ public function removeItem($invoiceItem) } /** - * Date on which the invoice was enabled. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $invoice_date * @@ -302,7 +384,7 @@ public function setInvoiceDate($invoice_date) } /** - * Date on which the invoice was enabled. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -312,7 +394,7 @@ public function getInvoiceDate() } /** - * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. + * Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both. * * @param \PayPal\Api\PaymentTerm $payment_term * @@ -325,7 +407,7 @@ public function setPaymentTerm($payment_term) } /** - * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. + * Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both. * * @return \PayPal\Api\PaymentTerm */ @@ -337,7 +419,7 @@ public function getPaymentTerm() /** * Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters. * - * @param String $reference + * @param string $reference * * @return $this */ @@ -350,7 +432,7 @@ public function setReference($reference) /** * Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters. * - * @return String + * @return string */ public function getReference() { @@ -358,7 +440,7 @@ public function getReference() } /** - * Invoice level discount in percent or amount. + * The invoice level discount, as a percent or an amount value. * * @param \PayPal\Api\Cost $discount * @@ -371,7 +453,7 @@ public function setDiscount($discount) } /** - * Invoice level discount in percent or amount. + * The invoice level discount, as a percent or an amount value. * * @return \PayPal\Api\Cost */ @@ -381,7 +463,7 @@ public function getDiscount() } /** - * Shipping cost in percent or amount. + * The shipping cost, as a percent or an amount value. * * @param \PayPal\Api\ShippingCost $shipping_cost * @@ -394,7 +476,7 @@ public function setShippingCost($shipping_cost) } /** - * Shipping cost in percent or amount. + * The shipping cost, as a percent or an amount value. * * @return \PayPal\Api\ShippingCost */ @@ -404,7 +486,7 @@ public function getShippingCost() } /** - * Custom amount applied on an invoice. If a label is included then the amount cannot be empty. + * The custom amount to apply on an invoice. If you include a label, the amount cannot be empty. * * @param \PayPal\Api\CustomAmount $custom * @@ -417,7 +499,7 @@ public function setCustom($custom) } /** - * Custom amount applied on an invoice. If a label is included then the amount cannot be empty. + * The custom amount to apply on an invoice. If you include a label, the amount cannot be empty. * * @return \PayPal\Api\CustomAmount */ @@ -427,7 +509,53 @@ public function getCustom() } /** - * 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. + * Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`. + * + * @param bool $allow_partial_payment + * + * @return $this + */ + public function setAllowPartialPayment($allow_partial_payment) + { + $this->allow_partial_payment = $allow_partial_payment; + return $this; + } + + /** + * Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`. + * + * @return bool + */ + public function getAllowPartialPayment() + { + return $this->allow_partial_payment; + } + + /** + * If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment. + * + * @param \PayPal\Api\Currency $minimum_amount_due + * + * @return $this + */ + public function setMinimumAmountDue($minimum_amount_due) + { + $this->minimum_amount_due = $minimum_amount_due; + return $this; + } + + /** + * If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment. + * + * @return \PayPal\Api\Currency + */ + public function getMinimumAmountDue() + { + return $this->minimum_amount_due; + } + + /** + * Indicates whether tax is calculated before or after a discount. If set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`. * * @param bool $tax_calculated_after_discount * @@ -440,7 +568,7 @@ public function setTaxCalculatedAfterDiscount($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. + * Indicates whether tax is calculated before or after a discount. If set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`. * * @return bool */ @@ -450,7 +578,7 @@ public function getTaxCalculatedAfterDiscount() } /** - * A flag indicating whether the unit price includes tax. Default is false + * Indicates whether the unit price includes tax. Default is `false`. * * @param bool $tax_inclusive * @@ -463,7 +591,7 @@ public function setTaxInclusive($tax_inclusive) } /** - * A flag indicating whether the unit price includes tax. Default is false + * Indicates whether the unit price includes tax. Default is `false`. * * @return bool */ @@ -519,7 +647,7 @@ public function getNote() } /** - * Bookkeeping memo that is private to the merchant. 150 characters max. + * A private bookkeeping memo for the merchant. Maximum length is 150 characters. * * @param string $merchant_memo * @@ -532,7 +660,7 @@ public function setMerchantMemo($merchant_memo) } /** - * Bookkeeping memo that is private to the merchant. 150 characters max. + * A private bookkeeping memo for the merchant. Maximum length is 150 characters. * * @return string */ @@ -542,7 +670,7 @@ public function getMerchantMemo() } /** - * Full URL of an external image to use as the logo. 4000 characters max. + * Full URL of an external image to use as the logo. Maximum length is 4000 characters. * * @param string $logo_url * @throws \InvalidArgumentException @@ -556,7 +684,7 @@ public function setLogoUrl($logo_url) } /** - * Full URL of an external image to use as the logo. 4000 characters max. + * Full URL of an external image to use as the logo. Maximum length is 4000 characters. * * @return string */ @@ -612,12 +740,12 @@ public function getPayments() } /** - * Append PaymentDetails to the list. + * Append Payments to the list. * * @param \PayPal\Api\PaymentDetail $paymentDetail * @return $this */ - public function addPaymentDetail($paymentDetail) + public function addPayment($paymentDetail) { if (!$this->getPayments()) { return $this->setPayments(array($paymentDetail)); @@ -629,12 +757,12 @@ public function addPaymentDetail($paymentDetail) } /** - * Remove PaymentDetails from the list. + * Remove Payments from the list. * * @param \PayPal\Api\PaymentDetail $paymentDetail * @return $this */ - public function removePaymentDetail($paymentDetail) + public function removePayment($paymentDetail) { return $this->setPayments( array_diff($this->getPayments(), array($paymentDetail)) @@ -665,12 +793,12 @@ public function getRefunds() } /** - * Append RefundDetails to the list. + * Append Refunds to the list. * * @param \PayPal\Api\RefundDetail $refundDetail * @return $this */ - public function addRefundDetail($refundDetail) + public function addRefund($refundDetail) { if (!$this->getRefunds()) { return $this->setRefunds(array($refundDetail)); @@ -682,12 +810,12 @@ public function addRefundDetail($refundDetail) } /** - * Remove RefundDetails from the list. + * Remove Refunds from the list. * * @param \PayPal\Api\RefundDetail $refundDetail * @return $this */ - public function removeRefundDetail($refundDetail) + public function removeRefund($refundDetail) { return $this->setRefunds( array_diff($this->getRefunds(), array($refundDetail)) @@ -718,8 +846,8 @@ public function getMetadata() } /** - * Any miscellaneous invoice data. 4000 characters max. - * + * Any miscellaneous invoice data. Maximum length is 4000 characters. + * @deprecated Not publicly available * @param string $additional_data * * @return $this @@ -731,8 +859,8 @@ public function setAdditionalData($additional_data) } /** - * Any miscellaneous invoice data. 4000 characters max. - * + * Any miscellaneous invoice data. Maximum length is 4000 characters. + * @deprecated Not publicly available * @return string */ public function getAdditionalData() @@ -741,7 +869,106 @@ public function getAdditionalData() } /** - * Create a new invoice by passing the details for the invoice, including the merchant_info, to the request URI. + * Payment summary of the invoice including amount paid through PayPal and other sources. + * + * @param \PayPal\Api\PaymentSummary $paid_amount + * + * @return $this + */ + public function setPaidAmount($paid_amount) + { + $this->paid_amount = $paid_amount; + return $this; + } + + /** + * Payment summary of the invoice including amount paid through PayPal and other sources. + * + * @return \PayPal\Api\PaymentSummary + */ + public function getPaidAmount() + { + return $this->paid_amount; + } + + /** + * Payment summary of the invoice including amount refunded through PayPal and other sources. + * + * @param \PayPal\Api\PaymentSummary $refunded_amount + * + * @return $this + */ + public function setRefundedAmount($refunded_amount) + { + $this->refunded_amount = $refunded_amount; + return $this; + } + + /** + * Payment summary of the invoice including amount refunded through PayPal and other sources. + * + * @return \PayPal\Api\PaymentSummary + */ + public function getRefundedAmount() + { + return $this->refunded_amount; + } + + /** + * List of files attached to the invoice. + * + * @param \PayPal\Api\FileAttachment[] $attachments + * + * @return $this + */ + public function setAttachments($attachments) + { + $this->attachments = $attachments; + return $this; + } + + /** + * List of files attached to the invoice. + * + * @return \PayPal\Api\FileAttachment[] + */ + public function getAttachments() + { + return $this->attachments; + } + + /** + * Append Attachments to the list. + * + * @param \PayPal\Api\FileAttachment $fileAttachment + * @return $this + */ + public function addAttachment($fileAttachment) + { + if (!$this->getAttachments()) { + return $this->setAttachments(array($fileAttachment)); + } else { + return $this->setAttachments( + array_merge($this->getAttachments(), array($fileAttachment)) + ); + } + } + + /** + * Remove Attachments from the list. + * + * @param \PayPal\Api\FileAttachment $fileAttachment + * @return $this + */ + public function removeAttachment($fileAttachment) + { + return $this->setAttachments( + array_diff($this->getAttachments(), array($fileAttachment)) + ); + } + + /** + * Creates an invoice. Include invoice details including merchant information in the request. * * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls @@ -763,7 +990,7 @@ public function create($apiContext = null, $restCall = null) } /** - * Search for a specific invoice or invoices by passing a search object that specifies your search criteria to the request URI. + * Searches for an invoice or invoices. Include a search object that specifies your search criteria in the request. * * @param Search $search * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. @@ -788,7 +1015,7 @@ public static function search($search, $apiContext = null, $restCall = null) } /** - * Send a specific invoice to its intended recipient by passing the invoice ID to the request URI. Optionally, you can specify whether to send the merchant an invoice update notification by using the notify_merchant query parameter. By default, notify_merchant is true. + * Sends an invoice, by ID, to a recipient. Optionally, set the `notify_merchant` query parameter to send the merchant an invoice update notification. By default, `notify_merchant` is `true`. * * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls @@ -810,7 +1037,7 @@ public function send($apiContext = null, $restCall = null) } /** - * Send a reminder about a specific invoice to its intended recipient by providing the ID of the invoice in the request URI. In addition, pass a notification object that specifies the subject of the reminder and other details in the request JSON. + * Sends a reminder about a specific invoice, by ID, to a recipient. Include a notification object that defines the reminder subject and other details in the JSON request body. * * @param Notification $notification * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. @@ -834,7 +1061,7 @@ public function remind($notification, $apiContext = null, $restCall = null) } /** - * Cancel an invoice by passing the invoice ID to the request URI. + * Cancels an invoice, by ID. * * @param CancelNotification $cancelNotification * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. @@ -858,7 +1085,7 @@ public function cancel($cancelNotification, $apiContext = null, $restCall = null } /** - * Mark the status of an invoice as paid by passing the invoice ID to the request URI. In addition, pass a payment detail object that specifies the payment method and other details in the request JSON. + * Marks the status of a specified invoice, by ID, as paid. Include a payment detail object that defines the payment method and other details in the JSON request body. * * @param PaymentDetail $paymentDetail * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. @@ -882,7 +1109,7 @@ public function recordPayment($paymentDetail, $apiContext = null, $restCall = nu } /** - * Mark the status of an invoice as refunded by passing the invoice ID to the request URI. In addition, pass a refund-detail object that specifies the type of refund and other details in the request JSON. + * Marks the status of a specified invoice, by ID, as refunded. Include a refund detail object that defines the refund type and other details in the JSON request body. * * @param RefundDetail $refundDetail * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. @@ -906,7 +1133,7 @@ public function recordRefund($refundDetail, $apiContext = null, $restCall = null } /** - * Retrieve the details for a particular invoice by passing the invoice ID to the request URI. + * Gets the details for a specified invoice, by ID. * * @param string $invoiceId * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. @@ -931,7 +1158,7 @@ public static function get($invoiceId, $apiContext = null, $restCall = null) } /** - * List some or all invoices for a merchant according to optional query string parameters specified. + * Lists some or all merchant invoices. Filters the response by any specified optional query string parameters. * * @param array $params * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. @@ -963,7 +1190,7 @@ public static function getAll($params = array(), $apiContext = null, $restCall = } /** - * Fully update an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Partial updates are not supported. + * Fully updates an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Does not support partial updates. * * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls @@ -986,7 +1213,7 @@ public function update($apiContext = null, $restCall = null) } /** - * Delete a particular invoice by passing the invoice ID to the request URI. + * Deletes an invoice, by ID. * * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls @@ -1041,4 +1268,27 @@ public static function qrCode($invoiceId, $params = array(), $apiContext = null, return $ret; } + /** + * Generate the successive invoice number for the merchant. + * + * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls + * @return InvoiceNumber + */ + public static function generateNumber($apiContext = null, $restCall = null) + { + $payLoad = ""; + $json = self::executeCall( + "/v1/invoicing/invoices/next-invoice-number", + "POST", + $payLoad, + null, + $apiContext, + $restCall + ); + $ret = new InvoiceNumber(); + $ret->fromJson($json); + return $ret; + } + } diff --git a/lib/PayPal/Api/InvoiceAddress.php b/lib/PayPal/Api/InvoiceAddress.php index 7e8786a5..8529df99 100644 --- a/lib/PayPal/Api/InvoiceAddress.php +++ b/lib/PayPal/Api/InvoiceAddress.php @@ -11,7 +11,7 @@ * * @property \PayPal\Api\Phone phone */ -class InvoiceAddress extends BaseAddress +class InvoiceAddress extends BaseAddress { /** * Phone number in E.123 format. diff --git a/lib/PayPal/Api/InvoiceItem.php b/lib/PayPal/Api/InvoiceItem.php index 33757629..08811c3d 100644 --- a/lib/PayPal/Api/InvoiceItem.php +++ b/lib/PayPal/Api/InvoiceItem.php @@ -5,6 +5,7 @@ use PayPal\Common\PayPalModel; use PayPal\Converter\FormatConverter; use PayPal\Validation\NumericValidator; +use PayPal\Validation\UrlValidator; /** * Class InvoiceItem @@ -20,11 +21,12 @@ * @property \PayPal\Api\Tax tax * @property string date * @property \PayPal\Api\Cost discount + * @property string unit_of_measure */ class InvoiceItem extends PayPalModel { /** - * Name of the item. 60 characters max. + * Name of the item. 200 characters max. * * @param string $name * @@ -37,7 +39,7 @@ public function setName($name) } /** - * Name of the item. 60 characters max. + * Name of the item. 200 characters max. * * @return string */ @@ -70,7 +72,7 @@ public function getDescription() } /** - * Quantity of the item. Range of 0 to 9999.999. + * Quantity of the item. Range of -10000 to 10000. * * @param string|double $quantity * @@ -85,7 +87,7 @@ public function setQuantity($quantity) } /** - * Quantity of the item. Range of 0 to 9999.999. + * Quantity of the item. Range of -10000 to 10000. * * @return string */ @@ -95,7 +97,7 @@ public function getQuantity() } /** - * Unit price of the item. Range of -999999.99 to 999999.99. + * Unit price of the item. Range of -1,000,000 to 1,000,000. * * @param \PayPal\Api\Currency $unit_price * @@ -108,7 +110,7 @@ public function setUnitPrice($unit_price) } /** - * Unit price of the item. Range of -999999.99 to 999999.99. + * Unit price of the item. Range of -1,000,000 to 1,000,000. * * @return \PayPal\Api\Currency */ @@ -141,7 +143,7 @@ public function getTax() } /** - * Date on which the item or service was provided. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the item or service was provided. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $date * @@ -154,7 +156,7 @@ public function setDate($date) } /** - * Date on which the item or service was provided. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the item or service was provided. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -164,7 +166,7 @@ public function getDate() } /** - * Item discount in percent or amount. + * The item discount, as a percent or an amount value. * * @param \PayPal\Api\Cost $discount * @@ -177,7 +179,7 @@ public function setDiscount($discount) } /** - * Item discount in percent or amount. + * The item discount, as a percent or an amount value. * * @return \PayPal\Api\Cost */ @@ -186,4 +188,52 @@ public function getDiscount() return $this->discount; } + /** + * The image URL. Maximum length is 4000 characters. + * @deprecated Not publicly available + * @param string $image_url + * @throws \InvalidArgumentException + * @return $this + */ + public function setImageUrl($image_url) + { + UrlValidator::validate($image_url, "ImageUrl"); + $this->image_url = $image_url; + return $this; + } + + /** + * The image URL. Maximum length is 4000 characters. + * @deprecated Not publicly available + * @return string + */ + public function getImageUrl() + { + return $this->image_url; + } + + /** + * The unit of measure of the item being invoiced. + * Valid Values: ["QUANTITY", "HOURS", "AMOUNT"] + * + * @param string $unit_of_measure + * + * @return $this + */ + public function setUnitOfMeasure($unit_of_measure) + { + $this->unit_of_measure = $unit_of_measure; + return $this; + } + + /** + * The unit of measure of the item being invoiced. + * + * @return string + */ + public function getUnitOfMeasure() + { + return $this->unit_of_measure; + } + } diff --git a/lib/PayPal/Api/InvoiceNumber.php b/lib/PayPal/Api/InvoiceNumber.php new file mode 100644 index 00000000..a3cd2e24 --- /dev/null +++ b/lib/PayPal/Api/InvoiceNumber.php @@ -0,0 +1,38 @@ +number = $number; + return $this; + } + + /** + * The next invoice number. + * + * @return string + */ + public function getNumber() { + return $this->number; + } +} diff --git a/lib/PayPal/Api/MerchantInfo.php b/lib/PayPal/Api/MerchantInfo.php index 4d97d8cf..72c561ed 100644 --- a/lib/PayPal/Api/MerchantInfo.php +++ b/lib/PayPal/Api/MerchantInfo.php @@ -7,7 +7,7 @@ /** * Class MerchantInfo * - * Business information of the merchant that will appear on the invoice. + * Merchant business information that appears on the invoice. * * @package PayPal\Api * @@ -20,12 +20,13 @@ * @property \PayPal\Api\Phone fax * @property string website * @property string tax_id + * @property string additional_info_label * @property string additional_info */ class MerchantInfo extends PayPalModel { /** - * Email address of the merchant. 260 characters max. + * The merchant email address. Maximum length is 260 characters. * * @param string $email * @@ -38,7 +39,7 @@ public function setEmail($email) } /** - * Email address of the merchant. 260 characters max. + * The merchant email address. Maximum length is 260 characters. * * @return string */ @@ -48,7 +49,7 @@ public function getEmail() } /** - * First name of the merchant. 30 characters max. + * The merchant first name. Maximum length is 30 characters. * * @param string $first_name * @@ -61,7 +62,7 @@ public function setFirstName($first_name) } /** - * First name of the merchant. 30 characters max. + * The merchant first name. Maximum length is 30 characters. * * @return string */ @@ -71,7 +72,7 @@ public function getFirstName() } /** - * Last name of the merchant. 30 characters max. + * The merchant last name. Maximum length is 30 characters. * * @param string $last_name * @@ -84,7 +85,7 @@ public function setLastName($last_name) } /** - * Last name of the merchant. 30 characters max. + * The merchant last name. Maximum length is 30 characters. * * @return string */ @@ -94,7 +95,7 @@ public function getLastName() } /** - * Address of the merchant. + * The merchant address. * * @param \PayPal\Api\InvoiceAddress $address * @@ -107,7 +108,7 @@ public function setAddress($address) } /** - * Address of the merchant. + * The merchant address. * * @return \PayPal\Api\InvoiceAddress */ @@ -117,7 +118,7 @@ public function getAddress() } /** - * Company business name of the merchant. 100 characters max. + * The merchant company business name. Maximum length is 100 characters. * * @param string $business_name * @@ -130,7 +131,7 @@ public function setBusinessName($business_name) } /** - * Company business name of the merchant. 100 characters max. + * The merchant company business name. Maximum length is 100 characters. * * @return string */ @@ -140,7 +141,7 @@ public function getBusinessName() } /** - * Phone number of the merchant. + * The merchant phone number. * * @param \PayPal\Api\Phone $phone * @@ -153,7 +154,7 @@ public function setPhone($phone) } /** - * Phone number of the merchant. + * The merchant phone number. * * @return \PayPal\Api\Phone */ @@ -163,7 +164,7 @@ public function getPhone() } /** - * Fax number of the merchant. + * The merchant fax number. * * @param \PayPal\Api\Phone $fax * @@ -176,7 +177,7 @@ public function setFax($fax) } /** - * Fax number of the merchant. + * The merchant fax number. * * @return \PayPal\Api\Phone */ @@ -186,7 +187,7 @@ public function getFax() } /** - * Website of the merchant. 2048 characters max. + * The merchant website. Maximum length is 2048 characters. * * @param string $website * @@ -199,7 +200,7 @@ public function setWebsite($website) } /** - * Website of the merchant. 2048 characters max. + * The merchant website. Maximum length is 2048 characters. * * @return string */ @@ -209,7 +210,7 @@ public function getWebsite() } /** - * Tax ID of the merchant. 100 characters max. + * The merchant tax ID. Maximum length is 100 characters. * * @param string $tax_id * @@ -222,7 +223,7 @@ public function setTaxId($tax_id) } /** - * Tax ID of the merchant. 100 characters max. + * The merchant tax ID. Maximum length is 100 characters. * * @return string */ @@ -232,7 +233,30 @@ public function getTaxId() } /** - * Option to display additional information such as business hours. 40 characters max. + * Option to provide a label to the additional_info field. 40 characters max. + * + * @param string $additional_info_label + * + * @return $this + */ + public function setAdditionalInfoLabel($additional_info_label) + { + $this->additional_info_label = $additional_info_label; + return $this; + } + + /** + * Option to provide a label to the additional_info field. 40 characters max. + * + * @return string + */ + public function getAdditionalInfoLabel() + { + return $this->additional_info_label; + } + + /** + * Additional information, such as business hours. Maximum length is 40 characters. * * @param string $additional_info * @@ -245,7 +269,7 @@ public function setAdditionalInfo($additional_info) } /** - * Option to display additional information such as business hours. 40 characters max. + * Additional information, such as business hours. Maximum length is 40 characters. * * @return string */ diff --git a/lib/PayPal/Api/Metadata.php b/lib/PayPal/Api/Metadata.php index d4f3eafb..8cddb026 100644 --- a/lib/PayPal/Api/Metadata.php +++ b/lib/PayPal/Api/Metadata.php @@ -8,7 +8,7 @@ /** * Class Metadata * - * Audit information of the resource. + * Audit information for the resource. * * @package PayPal\Api * @@ -26,7 +26,7 @@ class Metadata extends PayPalModel { /** - * Date when the resource was created. + * The date and time when the resource was created. * * @param string $created_date * @@ -39,7 +39,7 @@ public function setCreatedDate($created_date) } /** - * Date when the resource was created. + * The date and time when the resource was created. * * @return string */ @@ -49,7 +49,7 @@ public function getCreatedDate() } /** - * Email address of the account that created the resource. + * The email address of the account that created the resource. * * @param string $created_by * @@ -62,7 +62,7 @@ public function setCreatedBy($created_by) } /** - * Email address of the account that created the resource. + * The email address of the account that created the resource. * * @return string */ @@ -72,7 +72,7 @@ public function getCreatedBy() } /** - * Date when the resource was cancelled. + * The date and time when the resource was cancelled. * * @param string $cancelled_date * @@ -85,7 +85,7 @@ public function setCancelledDate($cancelled_date) } /** - * Date when the resource was cancelled. + * The date and time when the resource was cancelled. * * @return string */ @@ -95,7 +95,7 @@ public function getCancelledDate() } /** - * Actor who cancelled the resource. + * The actor who cancelled the resource. * * @param string $cancelled_by * @@ -108,7 +108,7 @@ public function setCancelledBy($cancelled_by) } /** - * Actor who cancelled the resource. + * The actor who cancelled the resource. * * @return string */ @@ -118,7 +118,7 @@ public function getCancelledBy() } /** - * Date when the resource was last edited. + * The date and time when the resource was last edited. * * @param string $last_updated_date * @@ -131,7 +131,7 @@ public function setLastUpdatedDate($last_updated_date) } /** - * Date when the resource was last edited. + * The date and time when the resource was last edited. * * @return string */ @@ -141,7 +141,7 @@ public function getLastUpdatedDate() } /** - * Email address of the account that last edited the resource. + * The email address of the account that last edited the resource. * * @param string $last_updated_by * @@ -154,7 +154,7 @@ public function setLastUpdatedBy($last_updated_by) } /** - * Email address of the account that last edited the resource. + * The email address of the account that last edited the resource. * * @return string */ @@ -164,7 +164,7 @@ public function getLastUpdatedBy() } /** - * Date when the resource was first sent. + * The date and time when the resource was first sent. * * @param string $first_sent_date * @@ -177,7 +177,7 @@ public function setFirstSentDate($first_sent_date) } /** - * Date when the resource was first sent. + * The date and time when the resource was first sent. * * @return string */ @@ -187,7 +187,7 @@ public function getFirstSentDate() } /** - * Date when the resource was last sent. + * The date and time when the resource was last sent. * * @param string $last_sent_date * @@ -200,7 +200,7 @@ public function setLastSentDate($last_sent_date) } /** - * Date when the resource was last sent. + * The date and time when the resource was last sent. * * @return string */ @@ -210,7 +210,7 @@ public function getLastSentDate() } /** - * Email address of the account that last sent the resource. + * The email address of the account that last sent the resource. * * @param string $last_sent_by * @@ -223,7 +223,7 @@ public function setLastSentBy($last_sent_by) } /** - * Email address of the account that last sent the resource. + * The email address of the account that last sent the resource. * * @return string */ diff --git a/lib/PayPal/Api/Notification.php b/lib/PayPal/Api/Notification.php index 743f0011..9b5a7722 100644 --- a/lib/PayPal/Api/Notification.php +++ b/lib/PayPal/Api/Notification.php @@ -14,6 +14,7 @@ * @property string subject * @property string note * @property bool send_to_merchant + * @property string[] cc_emails */ class Notification extends PayPalModel { @@ -64,7 +65,7 @@ public function getNote() } /** - * A flag indicating whether a copy of the email has to be sent to the merchant. + * Indicates whether to send a copy of the email to the merchant. * * @param bool $send_to_merchant * @@ -77,7 +78,7 @@ public function setSendToMerchant($send_to_merchant) } /** - * A flag indicating whether a copy of the email has to be sent to the merchant. + * Indicates whether to send a copy of the email to the merchant. * * @return bool */ @@ -86,4 +87,57 @@ public function getSendToMerchant() return $this->send_to_merchant; } + /** + * Applicable for invoices created with Cc emails. If this field is not in the body, all the cc email addresses added as part of the invoice shall be notified else this field can be used to limit the list of email addresses. Note: additional email addresses are not supported. + * + * @param string[] $cc_emails + * + * @return $this + */ + public function setCcEmails($cc_emails) + { + $this->cc_emails = $cc_emails; + return $this; + } + + /** + * Applicable for invoices created with Cc emails. If this field is not in the body, all the cc email addresses added as part of the invoice shall be notified else this field can be used to limit the list of email addresses. Note: additional email addresses are not supported. + * + * @return string[] + */ + public function getCcEmails() + { + return $this->cc_emails; + } + + /** + * Append CcEmails to the list. + * + * @param string $string + * @return $this + */ + public function addCcEmail($string) + { + if (!$this->getCcEmails()) { + return $this->setCcEmails(array($string)); + } else { + return $this->setCcEmails( + array_merge($this->getCcEmails(), array($string)) + ); + } + } + + /** + * Remove CcEmails from the list. + * + * @param string $string + * @return $this + */ + public function removeCcEmail($string) + { + return $this->setCcEmails( + array_diff($this->getCcEmails(), array($string)) + ); + } + } diff --git a/lib/PayPal/Api/Participant.php b/lib/PayPal/Api/Participant.php new file mode 100644 index 00000000..0f8e6d09 --- /dev/null +++ b/lib/PayPal/Api/Participant.php @@ -0,0 +1,233 @@ +email = $email; + return $this; + } + + /** + * The participant email address. + * + * @return string + */ + public function getEmail() + { + return $this->email; + } + + /** + * The participant first name. + * + * @param string $first_name + * + * @return $this + */ + public function setFirstName($first_name) + { + $this->first_name = $first_name; + return $this; + } + + /** + * The participant first name. + * + * @return string + */ + public function getFirstName() + { + return $this->first_name; + } + + /** + * The participant last name. + * + * @param string $last_name + * + * @return $this + */ + public function setLastName($last_name) + { + $this->last_name = $last_name; + return $this; + } + + /** + * The participant last name. + * + * @return string + */ + public function getLastName() + { + return $this->last_name; + } + + /** + * The participant company business name. + * + * @param string $business_name + * + * @return $this + */ + public function setBusinessName($business_name) + { + $this->business_name = $business_name; + return $this; + } + + /** + * The participant company business name. + * + * @return string + */ + public function getBusinessName() + { + return $this->business_name; + } + + /** + * The participant phone number. + * + * @param \PayPal\Api\Phone $phone + * + * @return $this + */ + public function setPhone($phone) + { + $this->phone = $phone; + return $this; + } + + /** + * The participant phone number. + * + * @return \PayPal\Api\Phone + */ + public function getPhone() + { + return $this->phone; + } + + /** + * The participant fax number. + * + * @param \PayPal\Api\Phone $fax + * + * @return $this + */ + public function setFax($fax) + { + $this->fax = $fax; + return $this; + } + + /** + * The participant fax number. + * + * @return \PayPal\Api\Phone + */ + public function getFax() + { + return $this->fax; + } + + /** + * The participant website. + * + * @param string $website + * + * @return $this + */ + public function setWebsite($website) + { + $this->website = $website; + return $this; + } + + /** + * The participant website. + * + * @return string + */ + public function getWebsite() + { + return $this->website; + } + + /** + * Additional information, such as business hours. + * + * @param string $additional_info + * + * @return $this + */ + public function setAdditionalInfo($additional_info) + { + $this->additional_info = $additional_info; + return $this; + } + + /** + * Additional information, such as business hours. + * + * @return string + */ + public function getAdditionalInfo() + { + return $this->additional_info; + } + + /** + * The participant address. + * + * @param \PayPal\Api\Address $address + * + * @return $this + */ + public function setAddress($address) + { + $this->address = $address; + return $this; + } + + /** + * The participant address. + * + * @return \PayPal\Api\Address + */ + public function getAddress() + { + return $this->address; + } + +} diff --git a/lib/PayPal/Api/PaymentDetail.php b/lib/PayPal/Api/PaymentDetail.php index 6cd29eaa..59305a72 100644 --- a/lib/PayPal/Api/PaymentDetail.php +++ b/lib/PayPal/Api/PaymentDetail.php @@ -17,11 +17,12 @@ * @property string date * @property string method * @property string note + * @property \PayPal\Api\Currency amount */ class PaymentDetail extends PayPalModel { /** - * 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. + * The PayPal payment detail. Indicates whether payment was made in an invoicing flow through PayPal or externally. In the case of the mark-as-paid API, the supported payment type is `EXTERNAL`. For backward compatibility, the `PAYPAL` payment type is still supported. * Valid Values: ["PAYPAL", "EXTERNAL"] * * @param string $type @@ -35,7 +36,7 @@ public function setType($type) } /** - * 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. + * The PayPal payment detail. Indicates whether payment was made in an invoicing flow through PayPal or externally. In the case of the mark-as-paid API, the supported payment type is `EXTERNAL`. For backward compatibility, the `PAYPAL` payment type is still supported. * * @return string */ @@ -45,7 +46,7 @@ public function getType() } /** - * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * The PayPal payment transaction ID. Required with the `PAYPAL` payment type. * * @param string $transaction_id * @@ -58,7 +59,7 @@ public function setTransactionId($transaction_id) } /** - * PayPal payment transaction id. Mandatory field in case the type value is PAYPAL. + * The PayPal payment transaction ID. Required with the `PAYPAL` payment type. * * @return string */ @@ -92,7 +93,7 @@ public function getTransactionType() } /** - * Date when the invoice was paid. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the invoice was paid. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $date * @@ -105,7 +106,7 @@ public function setDate($date) } /** - * Date when the invoice was paid. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the invoice was paid. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -115,7 +116,7 @@ public function getDate() } /** - * Payment mode or method. This field is mandatory if the value of the type field is EXTERNAL. + * The payment mode or method. Required with the `EXTERNAL` payment type. * Valid Values: ["BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"] * * @param string $method @@ -129,7 +130,7 @@ public function setMethod($method) } /** - * Payment mode or method. This field is mandatory if the value of the type field is EXTERNAL. + * The payment mode or method. Required with the `EXTERNAL` payment type. * * @return string */ @@ -139,7 +140,7 @@ public function getMethod() } /** - * Optional note associated with the payment. + * Optional. A note associated with the payment. * * @param string $note * @@ -152,7 +153,7 @@ public function setNote($note) } /** - * Optional note associated with the payment. + * Optional. A note associated with the payment. * * @return string */ @@ -161,4 +162,27 @@ public function getNote() return $this->note; } + /** + * The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment. + * + * @param \PayPal\Api\Currency $amount + * + * @return $this + */ + public function setAmount($amount) + { + $this->amount = $amount; + return $this; + } + + /** + * The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment. + * + * @return \PayPal\Api\Currency + */ + public function getAmount() + { + return $this->amount; + } + } diff --git a/lib/PayPal/Api/PaymentSummary.php b/lib/PayPal/Api/PaymentSummary.php new file mode 100644 index 00000000..3fcc5d67 --- /dev/null +++ b/lib/PayPal/Api/PaymentSummary.php @@ -0,0 +1,65 @@ +paypal = $paypal; + return $this; + } + + /** + * Total Amount paid/refunded via PayPal. + * + * @return \PayPal\Api\Currency + */ + public function getPaypal() + { + return $this->paypal; + } + + /** + * Total Amount paid/refunded via other sources. + * + * @param \PayPal\Api\Currency $other + * + * @return $this + */ + public function setOther($other) + { + $this->other = $other; + return $this; + } + + /** + * Total Amount paid/refunded via other sources. + * + * @return \PayPal\Api\Currency + */ + public function getOther() + { + return $this->other; + } + +} diff --git a/lib/PayPal/Api/PaymentTerm.php b/lib/PayPal/Api/PaymentTerm.php index 0a0dbabd..ee62f6d9 100644 --- a/lib/PayPal/Api/PaymentTerm.php +++ b/lib/PayPal/Api/PaymentTerm.php @@ -7,7 +7,7 @@ /** * Class PaymentTerm * - * Payment term of the invoice. If term_type is present, due_date must not be present and vice versa. + * The payment term of the invoice. If you specify `term_type`, you cannot specify `due_date` and vice versa. * * @package PayPal\Api * @@ -17,8 +17,8 @@ class PaymentTerm extends PayPalModel { /** - * Terms by which the invoice payment is due. - * Valid Values: ["DUE_ON_RECEIPT", "NET_10", "NET_15", "NET_30", "NET_45"] + * The terms by which the invoice payment is due. + * Valid Values: ["DUE_ON_RECEIPT", "DUE_ON_DATE_SPECIFIED", "NET_10", "NET_15", "NET_30", "NET_45", "NET_60", "NET_90", "NO_DUE_DATE"] * * @param string $term_type * @@ -31,7 +31,7 @@ public function setTermType($term_type) } /** - * Terms by which the invoice payment is due. + * The terms by which the invoice payment is due. * * @return string */ @@ -41,7 +41,7 @@ public function getTermType() } /** - * Date on which invoice payment is due. It must be always a future date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the invoice payment is due. This date must be a future date. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $due_date * @@ -54,7 +54,7 @@ public function setDueDate($due_date) } /** - * Date on which invoice payment is due. It must be always a future date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The date when the invoice payment is due. This date must be a future date. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ diff --git a/lib/PayPal/Api/Phone.php b/lib/PayPal/Api/Phone.php index 8f9d89fe..16c0523d 100644 --- a/lib/PayPal/Api/Phone.php +++ b/lib/PayPal/Api/Phone.php @@ -7,7 +7,7 @@ /** * Class Phone * - * 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. + * Representation of a phone number. * * @package PayPal\Api * @@ -18,7 +18,7 @@ class Phone extends PayPalModel { /** - * Country code (from in E.164 format) + * The country calling code (CC) as defined by E.164. The combined length of CC+national cannot be more than 15 digits. * * @param string $country_code * @@ -31,7 +31,7 @@ public function setCountryCode($country_code) } /** - * Country code (from in E.164 format) + * The country calling code (CC) as defined by E.164. The combined length of CC+national cannot be more than 15 digits. * * @return string */ @@ -41,7 +41,7 @@ public function getCountryCode() } /** - * In-country phone number (from in E.164 format) + * The national number as defined by E.164. The combined length of CC+national cannot be more than 15 digits. A national number consists of National Destination Code (NDC) and Subscriber Number (SN). * * @param string $national_number * @@ -54,7 +54,7 @@ public function setNationalNumber($national_number) } /** - * In-country phone number (from in E.164 format) + * The national number as defined by E.164. The combined length of CC+national cannot be more than 15 digits. A national number consists of National Destination Code (NDC) and Subscriber Number (SN). * * @return string */ @@ -67,7 +67,7 @@ public function getNationalNumber() * Phone extension * * @param string $extension - * + * * @return $this */ public function setExtension($extension) diff --git a/lib/PayPal/Api/RefundDetail.php b/lib/PayPal/Api/RefundDetail.php index 26023b02..e2b293c6 100644 --- a/lib/PayPal/Api/RefundDetail.php +++ b/lib/PayPal/Api/RefundDetail.php @@ -14,11 +14,12 @@ * @property string type * @property string date * @property string note + * @property \PayPal\Api\Currency amount */ class RefundDetail extends PayPalModel { /** - * 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. + * The PayPal refund type. Indicates whether refund was paid in invoicing flow through PayPal or externally. In the case of mark-as-refunded API, the supported refund type is `EXTERNAL`. For backward compatability, the `PAYPAL` refund type is still supported. * Valid Values: ["PAYPAL", "EXTERNAL"] * * @param string $type @@ -32,7 +33,7 @@ public function setType($type) } /** - * 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. + * The PayPal refund type. Indicates whether refund was paid in invoicing flow through PayPal or externally. In the case of mark-as-refunded API, the supported refund type is `EXTERNAL`. For backward compatability, the `PAYPAL` refund type is still supported. * * @return string */ @@ -42,7 +43,7 @@ public function getType() } /** - * 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. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. * * @param string $date * @@ -55,7 +56,7 @@ public function setDate($date) } /** - * 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. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * Date on which the invoice was refunded. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST. * * @return string */ @@ -87,4 +88,27 @@ public function getNote() return $this->note; } + /** + * Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund. + * + * @param \PayPal\Api\Currency $amount + * + * @return $this + */ + public function setAmount($amount) + { + $this->amount = $amount; + return $this; + } + + /** + * Amount to be recorded as refund against invoice. If this field is not passed, the total invoice paid amount is recorded as refund. + * + * @return \PayPal\Api\Currency + */ + public function getAmount() + { + return $this->amount; + } + } diff --git a/lib/PayPal/Api/Search.php b/lib/PayPal/Api/Search.php index 0594f9a1..333d99d4 100644 --- a/lib/PayPal/Api/Search.php +++ b/lib/PayPal/Api/Search.php @@ -30,11 +30,12 @@ * @property \PayPal\Api\number page * @property \PayPal\Api\number page_size * @property bool total_count_required + * @property bool archived */ class Search extends PayPalModel { /** - * Initial letters of the email address. + * The initial letters of the email address. * * @param string $email * @@ -47,7 +48,7 @@ public function setEmail($email) } /** - * Initial letters of the email address. + * The initial letters of the email address. * * @return string */ @@ -57,7 +58,7 @@ public function getEmail() } /** - * Initial letters of the recipient's first name. + * The initial letters of the recipient's first name. * * @param string $recipient_first_name * @@ -70,7 +71,7 @@ public function setRecipientFirstName($recipient_first_name) } /** - * Initial letters of the recipient's first name. + * The initial letters of the recipient's first name. * * @return string */ @@ -80,7 +81,7 @@ public function getRecipientFirstName() } /** - * Initial letters of the recipient's last name. + * The initial letters of the recipient's last name. * * @param string $recipient_last_name * @@ -93,7 +94,7 @@ public function setRecipientLastName($recipient_last_name) } /** - * Initial letters of the recipient's last name. + * The initial letters of the recipient's last name. * * @return string */ @@ -103,7 +104,7 @@ public function getRecipientLastName() } /** - * Initial letters of the recipient's business name. + * The initial letters of the recipient's business name. * * @param string $recipient_business_name * @@ -116,7 +117,7 @@ public function setRecipientBusinessName($recipient_business_name) } /** - * Initial letters of the recipient's business name. + * The initial letters of the recipient's business name. * * @return string */ @@ -126,7 +127,7 @@ public function getRecipientBusinessName() } /** - * The invoice number that appears on the invoice. + * The invoice number. * * @param string $number * @@ -139,7 +140,7 @@ public function setNumber($number) } /** - * The invoice number that appears on the invoice. + * The invoice number. * * @return string */ @@ -149,7 +150,7 @@ public function getNumber() } /** - * Status of the invoice. + * The invoice status. * Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"] * * @param string $status @@ -163,7 +164,7 @@ public function setStatus($status) } /** - * Status of the invoice. + * The invoice status. * * @return string */ @@ -173,7 +174,7 @@ public function getStatus() } /** - * Lower limit of total amount. + * The lower limit of the total amount. * * @param \PayPal\Api\Currency $lower_total_amount * @@ -186,7 +187,7 @@ public function setLowerTotalAmount($lower_total_amount) } /** - * Lower limit of total amount. + * The lower limit of the total amount. * * @return \PayPal\Api\Currency */ @@ -196,7 +197,7 @@ public function getLowerTotalAmount() } /** - * Upper limit of total amount. + * The upper limit of total amount. * * @param \PayPal\Api\Currency $upper_total_amount * @@ -209,7 +210,7 @@ public function setUpperTotalAmount($upper_total_amount) } /** - * Upper limit of total amount. + * The upper limit of total amount. * * @return \PayPal\Api\Currency */ @@ -219,7 +220,7 @@ public function getUpperTotalAmount() } /** - * Start invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $start_invoice_date * @@ -232,7 +233,7 @@ public function setStartInvoiceDate($start_invoice_date) } /** - * Start invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -242,7 +243,7 @@ public function getStartInvoiceDate() } /** - * End invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $end_invoice_date * @@ -255,7 +256,7 @@ public function setEndInvoiceDate($end_invoice_date) } /** - * End invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -265,7 +266,7 @@ public function getEndInvoiceDate() } /** - * Start invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $start_due_date * @@ -278,7 +279,7 @@ public function setStartDueDate($start_due_date) } /** - * Start invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -288,7 +289,7 @@ public function getStartDueDate() } /** - * End invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $end_due_date * @@ -301,7 +302,7 @@ public function setEndDueDate($end_due_date) } /** - * End invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -311,7 +312,7 @@ public function getEndDueDate() } /** - * Start invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $start_payment_date * @@ -324,7 +325,7 @@ public function setStartPaymentDate($start_payment_date) } /** - * Start invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -334,7 +335,7 @@ public function getStartPaymentDate() } /** - * End invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $end_payment_date * @@ -347,7 +348,7 @@ public function setEndPaymentDate($end_payment_date) } /** - * End invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -357,7 +358,7 @@ public function getEndPaymentDate() } /** - * Start invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $start_creation_date * @@ -370,7 +371,7 @@ public function setStartCreationDate($start_creation_date) } /** - * Start invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -380,7 +381,7 @@ public function getStartCreationDate() } /** - * End invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @param string $end_creation_date * @@ -393,7 +394,7 @@ public function setEndCreationDate($end_creation_date) } /** - * End invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). + * The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). * * @return string */ @@ -403,7 +404,7 @@ public function getEndCreationDate() } /** - * Offset of the search results. + * The offset for the search results. * * @param \PayPal\Api\number $page * @@ -416,7 +417,7 @@ public function setPage($page) } /** - * Offset of the search results. + * The offset for the search results. * * @return \PayPal\Api\number */ @@ -426,7 +427,7 @@ public function getPage() } /** - * Page size of the search results. + * The page size for the search results. * * @param \PayPal\Api\number $page_size * @@ -439,7 +440,7 @@ public function setPageSize($page_size) } /** - * Page size of the search results. + * The page size for the search results. * * @return \PayPal\Api\number */ @@ -449,7 +450,7 @@ public function getPageSize() } /** - * A flag indicating whether total count is required in the response. + * Indicates whether the total count appears in the response. Default is `false`. * * @param bool $total_count_required * @@ -462,7 +463,7 @@ public function setTotalCountRequired($total_count_required) } /** - * A flag indicating whether total count is required in the response. + * Indicates whether the total count appears in the response. Default is `false`. * * @return bool */ @@ -471,4 +472,27 @@ public function getTotalCountRequired() return $this->total_count_required; } + /** + * A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all. + * + * @param bool $archived + * + * @return $this + */ + public function setArchived($archived) + { + $this->archived = $archived; + return $this; + } + + /** + * A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all. + * + * @return bool + */ + public function getArchived() + { + return $this->archived; + } + } diff --git a/lib/PayPal/Api/ShippingCost.php b/lib/PayPal/Api/ShippingCost.php index b4beeb83..96694c42 100644 --- a/lib/PayPal/Api/ShippingCost.php +++ b/lib/PayPal/Api/ShippingCost.php @@ -7,7 +7,7 @@ /** * Class ShippingCost * - * Shipping cost in percent or amount. + * Shipping cost, as a percent or an amount. * * @package PayPal\Api * @@ -17,7 +17,7 @@ class ShippingCost extends PayPalModel { /** - * Shipping cost in amount. Range of 0 to 999999.99. + * The shipping cost, as an amount. Valid range is from 0 to 999999.99. * * @param \PayPal\Api\Currency $amount * @@ -30,7 +30,7 @@ public function setAmount($amount) } /** - * Shipping cost in amount. Range of 0 to 999999.99. + * The shipping cost, as an amount. Valid range is from 0 to 999999.99. * * @return \PayPal\Api\Currency */ @@ -40,7 +40,7 @@ public function getAmount() } /** - * Tax percentage on shipping amount. + * The tax percentage on the shipping amount. * * @param \PayPal\Api\Tax $tax * @@ -53,7 +53,7 @@ public function setTax($tax) } /** - * Tax percentage on shipping amount. + * The tax percentage on the shipping amount. * * @return \PayPal\Api\Tax */ diff --git a/lib/PayPal/Api/ShippingInfo.php b/lib/PayPal/Api/ShippingInfo.php index 6937b03b..fc31852e 100644 --- a/lib/PayPal/Api/ShippingInfo.php +++ b/lib/PayPal/Api/ShippingInfo.php @@ -20,7 +20,7 @@ class ShippingInfo extends PayPalModel { /** - * First name of the invoice recipient. 30 characters max. + * The invoice recipient first name. Maximum length is 30 characters. * * @param string $first_name * @@ -33,7 +33,7 @@ public function setFirstName($first_name) } /** - * First name of the invoice recipient. 30 characters max. + * The invoice recipient first name. Maximum length is 30 characters. * * @return string */ @@ -43,7 +43,7 @@ public function getFirstName() } /** - * Last name of the invoice recipient. 30 characters max. + * The invoice recipient last name. Maximum length is 30 characters. * * @param string $last_name * @@ -56,7 +56,7 @@ public function setLastName($last_name) } /** - * Last name of the invoice recipient. 30 characters max. + * The invoice recipient last name. Maximum length is 30 characters. * * @return string */ @@ -66,7 +66,7 @@ public function getLastName() } /** - * Company business name of the invoice recipient. 100 characters max. + * The invoice recipient company business name. Maximum length is 100 characters. * * @param string $business_name * @@ -79,7 +79,7 @@ public function setBusinessName($business_name) } /** - * Company business name of the invoice recipient. 100 characters max. + * The invoice recipient company business name. Maximum length is 100 characters. * * @return string */ @@ -146,7 +146,7 @@ public function setAddress($address) } /** - * Address of the invoice recipient. + * The invoice recipient address. * * @return \PayPal\Api\InvoiceAddress */ diff --git a/lib/PayPal/Api/Tax.php b/lib/PayPal/Api/Tax.php index ce6b9f2a..e83192c7 100644 --- a/lib/PayPal/Api/Tax.php +++ b/lib/PayPal/Api/Tax.php @@ -21,7 +21,7 @@ class Tax extends PayPalModel { /** - * Identifier of the resource. + * The resource ID. * * @param string $id * @@ -34,7 +34,7 @@ public function setId($id) } /** - * Identifier of the resource. + * The resource ID. * * @return string */ @@ -44,7 +44,7 @@ public function getId() } /** - * Name of the tax. 10 characters max. + * The tax name. Maximum length is 20 characters. * * @param string $name * @@ -57,7 +57,7 @@ public function setName($name) } /** - * Name of the tax. 10 characters max. + * The tax name. Maximum length is 20 characters. * * @return string */ @@ -67,7 +67,7 @@ public function getName() } /** - * Rate of the specified tax. Range of 0.001 to 99.999. + * The rate of the specified tax. Valid range is from 0.001 to 99.999. * * @param string|double $percent * @@ -82,7 +82,7 @@ public function setPercent($percent) } /** - * Rate of the specified tax. Range of 0.001 to 99.999. + * The rate of the specified tax. Valid range is from 0.001 to 99.999. * * @return string */ @@ -92,7 +92,7 @@ public function getPercent() } /** - * Tax in the form of money. Cannot be specified in a request. + * The tax as a monetary amount. Cannot be specified in a request. * * @param \PayPal\Api\Currency $amount * @@ -105,7 +105,7 @@ public function setAmount($amount) } /** - * Tax in the form of money. Cannot be specified in a request. + * The tax as a monetary amount. Cannot be specified in a request. * * @return \PayPal\Api\Currency */ diff --git a/lib/PayPal/Api/Template.php b/lib/PayPal/Api/Template.php new file mode 100644 index 00000000..e3a11044 --- /dev/null +++ b/lib/PayPal/Api/Template.php @@ -0,0 +1,215 @@ +template_id = $template_id; + return $this; + } + + /** + * Unique identifier id of the template. + * + * @return string + */ + public function getTemplateId() + { + return $this->template_id; + } + + /** + * Name of the template. + * + * @param string $name + * + * @return $this + */ + public function setName($name) + { + $this->name = $name; + return $this; + } + + /** + * Name of the template. + * + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Indicates that this template is merchant's default. There can be only one template which can be a default. + * + * @param bool $default + * + * @return $this + */ + public function setDefault($default) + { + $this->default = $default; + return $this; + } + + /** + * Indicates that this template is merchant's default. There can be only one template which can be a default. + * + * @return bool + */ + public function getDefault() + { + return $this->default; + } + + /** + * Customized invoice data which is saved as template + * + * @param \PayPal\Api\TemplateData $template_data + * + * @return $this + */ + public function setTemplateData($template_data) + { + $this->template_data = $template_data; + return $this; + } + + /** + * Customized invoice data which is saved as template + * + * @return \PayPal\Api\TemplateData + */ + public function getTemplateData() + { + return $this->template_data; + } + + /** + * Settings for each template + * + * @param \PayPal\Api\TemplateSettings[] $settings + * + * @return $this + */ + public function setSettings($settings) + { + $this->settings = $settings; + return $this; + } + + /** + * Settings for each template + * + * @return \PayPal\Api\TemplateSettings[] + */ + public function getSettings() + { + return $this->settings; + } + + /** + * Append Settings to the list. + * + * @param \PayPal\Api\TemplateSettings $templateSettings + * @return $this + */ + public function addSetting($templateSettings) + { + if (!$this->getSettings()) { + return $this->setSettings(array($templateSettings)); + } else { + return $this->setSettings( + array_merge($this->getSettings(), array($templateSettings)) + ); + } + } + + /** + * Remove Settings from the list. + * + * @param \PayPal\Api\TemplateSettings $templateSettings + * @return $this + */ + public function removeSetting($templateSettings) + { + return $this->setSettings( + array_diff($this->getSettings(), array($templateSettings)) + ); + } + + /** + * Unit of measure for the template, possible values are Quantity, Hours, Amount. + * + * @param string $unit_of_measure + * + * @return $this + */ + public function setUnitOfMeasure($unit_of_measure) + { + $this->unit_of_measure = $unit_of_measure; + return $this; + } + + /** + * Unit of measure for the template, possible values are Quantity, Hours, Amount. + * + * @return string + */ + public function getUnitOfMeasure() + { + return $this->unit_of_measure; + } + + /** + * Indicates whether this is a custom template created by the merchant. Non custom templates are system generated + * + * @param bool $custom + * + * @return $this + */ + public function setCustom($custom) + { + $this->custom = $custom; + return $this; + } + + /** + * Indicates whether this is a custom template created by the merchant. Non custom templates are system generated + * + * @return bool + */ + public function getCustom() + { + return $this->custom; + } + +} diff --git a/lib/PayPal/Api/TemplateData.php b/lib/PayPal/Api/TemplateData.php new file mode 100644 index 00000000..b0c3569e --- /dev/null +++ b/lib/PayPal/Api/TemplateData.php @@ -0,0 +1,619 @@ +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; + } + + /** + * The required invoice recipient email address and any optional billing information. One recipient is supported. + * + * @param \PayPal\Api\BillingInfo[] $billing_info + * + * @return $this + */ + public function setBillingInfo($billing_info) + { + $this->billing_info = $billing_info; + return $this; + } + + /** + * The required invoice recipient email address and any optional billing information. One recipient is supported. + * + * @return \PayPal\Api\BillingInfo[] + */ + public function getBillingInfo() + { + return $this->billing_info; + } + + /** + * Append BillingInfo to the list. + * + * @param \PayPal\Api\BillingInfo $billingInfo + * @return $this + */ + public function addBillingInfo($billingInfo) + { + if (!$this->getBillingInfo()) { + return $this->setBillingInfo(array($billingInfo)); + } else { + return $this->setBillingInfo( + array_merge($this->getBillingInfo(), array($billingInfo)) + ); + } + } + + /** + * Remove BillingInfo from the list. + * + * @param \PayPal\Api\BillingInfo $billingInfo + * @return $this + */ + public function removeBillingInfo($billingInfo) + { + return $this->setBillingInfo( + array_diff($this->getBillingInfo(), array($billingInfo)) + ); + } + + /** + * For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant. + * + * @param string $cc_info + * + * @return $this + */ + public function setCcInfo($cc_info) + { + $this->cc_info = $cc_info; + return $this; + } + + /** + * For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant. + * + * @return string[] + */ + public function getCcInfo() + { + return $this->cc_info; + } + + /** + * Append CcInfo to the list. + * + * @param string $email + * @return $this + */ + public function addCcInfo($email) + { + if (!$this->getCcInfo()) { + return $this->setCcInfo(array($email)); + } else { + return $this->setCcInfo( + array_merge($this->getCcInfo(), array($email)) + ); + } + } + + /** + * Remove CcInfo from the list. + * + * @param string $email + * @return $this + */ + public function removeCcInfo($email) + { + return $this->setCcInfo( + array_diff($this->getCcInfo(), array($email)) + ); + } + + /** + * The shipping information for entities to whom items are being shipped. + * + * @param \PayPal\Api\ShippingInfo $shipping_info + * + * @return $this + */ + public function setShippingInfo($shipping_info) + { + $this->shipping_info = $shipping_info; + return $this; + } + + /** + * The shipping information for entities to whom items are being shipped. + * + * @return \PayPal\Api\ShippingInfo + */ + public function getShippingInfo() + { + return $this->shipping_info; + } + + /** + * The list of items to include in the invoice. Maximum value is 100 items per invoice. + * + * @param \PayPal\Api\InvoiceItem[] $items + * + * @return $this + */ + public function setItems($items) + { + $this->items = $items; + return $this; + } + + /** + * The list of items to include in the invoice. Maximum value is 100 items per invoice. + * + * @return \PayPal\Api\InvoiceItem[] + */ + public function getItems() + { + return $this->items; + } + + /** + * Append Items to the list. + * + * @param \PayPal\Api\InvoiceItem $invoiceItem + * @return $this + */ + public function addItem($invoiceItem) + { + if (!$this->getItems()) { + return $this->setItems(array($invoiceItem)); + } else { + return $this->setItems( + array_merge($this->getItems(), array($invoiceItem)) + ); + } + } + + /** + * Remove Items from the list. + * + * @param \PayPal\Api\InvoiceItem $invoiceItem + * @return $this + */ + public function removeItem($invoiceItem) + { + return $this->setItems( + array_diff($this->getItems(), array($invoiceItem)) + ); + } + + /** + * Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both. + * + * @param \PayPal\Api\PaymentTerm $payment_term + * + * @return $this + */ + public function setPaymentTerm($payment_term) + { + $this->payment_term = $payment_term; + return $this; + } + + /** + * Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both. + * + * @return \PayPal\Api\PaymentTerm + */ + public function getPaymentTerm() + { + return $this->payment_term; + } + + /** + * Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters. + * + * @param string $reference + * + * @return $this + */ + public function setReference($reference) + { + $this->reference = $reference; + return $this; + } + + /** + * Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters. + * + * @return string + */ + public function getReference() + { + return $this->reference; + } + + /** + * The invoice level discount, as a percent or an amount value. + * + * @param \PayPal\Api\Cost $discount + * + * @return $this + */ + public function setDiscount($discount) + { + $this->discount = $discount; + return $this; + } + + /** + * The invoice level discount, as a percent or an amount value. + * + * @return \PayPal\Api\Cost + */ + public function getDiscount() + { + return $this->discount; + } + + /** + * The shipping cost, as a percent or an amount value. + * + * @param \PayPal\Api\ShippingCost $shipping_cost + * + * @return $this + */ + public function setShippingCost($shipping_cost) + { + $this->shipping_cost = $shipping_cost; + return $this; + } + + /** + * The shipping cost, as a percent or an amount value. + * + * @return \PayPal\Api\ShippingCost + */ + public function getShippingCost() + { + return $this->shipping_cost; + } + + /** + * The custom amount to apply on an invoice. If you include a label, the amount cannot be empty. + * + * @param \PayPal\Api\CustomAmount $custom + * + * @return $this + */ + public function setCustom($custom) + { + $this->custom = $custom; + return $this; + } + + /** + * The custom amount to apply on an invoice. If you include a label, the amount cannot be empty. + * + * @return \PayPal\Api\CustomAmount + */ + public function getCustom() + { + return $this->custom; + } + + /** + * Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`. + * + * @param bool $allow_partial_payment + * + * @return $this + */ + public function setAllowPartialPayment($allow_partial_payment) + { + $this->allow_partial_payment = $allow_partial_payment; + return $this; + } + + /** + * Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`. + * + * @return bool + */ + public function getAllowPartialPayment() + { + return $this->allow_partial_payment; + } + + /** + * If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment. + * + * @param \PayPal\Api\Currency $minimum_amount_due + * + * @return $this + */ + public function setMinimumAmountDue($minimum_amount_due) + { + $this->minimum_amount_due = $minimum_amount_due; + return $this; + } + + /** + * If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment. + * + * @return \PayPal\Api\Currency + */ + public function getMinimumAmountDue() + { + return $this->minimum_amount_due; + } + + /** + * Indicates whether tax is calculated before or after a discount. If set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`. + * + * @param bool $tax_calculated_after_discount + * + * @return $this + */ + 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 set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`. + * + * @return bool + */ + public function getTaxCalculatedAfterDiscount() + { + return $this->tax_calculated_after_discount; + } + + /** + * Indicates whether the unit price includes tax. Default is `false`. + * + * @param bool $tax_inclusive + * + * @return $this + */ + public function setTaxInclusive($tax_inclusive) + { + $this->tax_inclusive = $tax_inclusive; + return $this; + } + + /** + * Indicates whether the unit price includes tax. Default is `false`. + * + * @return bool + */ + public function getTaxInclusive() + { + return $this->tax_inclusive; + } + + /** + * General terms of the invoice. 4000 characters max. + * + * @param string $terms + * + * @return $this + */ + 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 + * + * @return $this + */ + public function setNote($note) + { + $this->note = $note; + return $this; + } + + /** + * Note to the payer. 4000 characters max. + * + * @return string + */ + public function getNote() + { + return $this->note; + } + + /** + * A private bookkeeping memo for the merchant. Maximum length is 150 characters. + * + * @param string $merchant_memo + * + * @return $this + */ + public function setMerchantMemo($merchant_memo) + { + $this->merchant_memo = $merchant_memo; + return $this; + } + + /** + * A private bookkeeping memo for the merchant. Maximum length is 150 characters. + * + * @return string + */ + public function getMerchantMemo() + { + return $this->merchant_memo; + } + + /** + * Full URL of an external image to use as the logo. Maximum length is 4000 characters. + * + * @param string $logo_url + * @throws \InvalidArgumentException + * @return $this + */ + public function setLogoUrl($logo_url) + { + UrlValidator::validate($logo_url, "LogoUrl"); + $this->logo_url = $logo_url; + return $this; + } + + /** + * Full URL of an external image to use as the logo. Maximum length is 4000 characters. + * + * @return string + */ + public function getLogoUrl() + { + return $this->logo_url; + } + + /** + * The total amount of the invoice. + * + * @param \PayPal\Api\Currency $total_amount + * + * @return $this + */ + 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; + } + + /** + * List of files attached to the invoice. + * + * @param \PayPal\Api\FileAttachment[] $attachments + * + * @return $this + */ + public function setAttachments($attachments) + { + $this->attachments = $attachments; + return $this; + } + + /** + * List of files attached to the invoice. + * + * @return \PayPal\Api\FileAttachment[] + */ + public function getAttachments() + { + return $this->attachments; + } + + /** + * Append Attachments to the list. + * + * @param \PayPal\Api\FileAttachment $fileAttachment + * @return $this + */ + public function addAttachment($fileAttachment) + { + if (!$this->getAttachments()) { + return $this->setAttachments(array($fileAttachment)); + } else { + return $this->setAttachments( + array_merge($this->getAttachments(), array($fileAttachment)) + ); + } + } + + /** + * Remove Attachments from the list. + * + * @param \PayPal\Api\FileAttachment $fileAttachment + * @return $this + */ + public function removeAttachment($fileAttachment) + { + return $this->setAttachments( + array_diff($this->getAttachments(), array($fileAttachment)) + ); + } + +} diff --git a/lib/PayPal/Api/TemplateSettings.php b/lib/PayPal/Api/TemplateSettings.php new file mode 100644 index 00000000..60be389b --- /dev/null +++ b/lib/PayPal/Api/TemplateSettings.php @@ -0,0 +1,65 @@ +field_name = $field_name; + return $this; + } + + /** + * The field name (for any field in template_data) for which the corresponding display preferences will be mapped to. + * + * @return string + */ + public function getFieldName() + { + return $this->field_name; + } + + /** + * Settings metadata for each field. + * + * @param \PayPal\Api\TemplateSettingsMetadata $display_preference + * + * @return $this + */ + public function setDisplayPreference($display_preference) + { + $this->display_preference = $display_preference; + return $this; + } + + /** + * Settings metadata for each field. + * + * @return \PayPal\Api\TemplateSettingsMetadata + */ + public function getDisplayPreference() + { + return $this->display_preference; + } + +} diff --git a/lib/PayPal/Api/TemplateSettingsMetadata.php b/lib/PayPal/Api/TemplateSettingsMetadata.php new file mode 100644 index 00000000..7084a040 --- /dev/null +++ b/lib/PayPal/Api/TemplateSettingsMetadata.php @@ -0,0 +1,41 @@ +hidden = $hidden; + return $this; + } + + /** + * Indicates whether this field should be hidden. default is false + * + * @return bool + */ + public function getHidden() + { + return $this->hidden; + } + +} diff --git a/lib/PayPal/Api/Templates.php b/lib/PayPal/Api/Templates.php new file mode 100644 index 00000000..4ecb376e --- /dev/null +++ b/lib/PayPal/Api/Templates.php @@ -0,0 +1,290 @@ +addresses = $addresses; + return $this; + } + + /** + * List of addresses in merchant's profile. + * + * @return \PayPal\Api\Address[] + */ + public function getAddresses() + { + return $this->addresses; + } + + /** + * Append Addresses to the list. + * + * @param \PayPal\Api\Address $address + * @return $this + */ + public function addAddress($address) + { + if (!$this->getAddresses()) { + return $this->setAddresses(array($address)); + } else { + return $this->setAddresses( + array_merge($this->getAddresses(), array($address)) + ); + } + } + + /** + * Remove Addresses from the list. + * + * @param \PayPal\Api\Address $address + * @return $this + */ + public function removeAddress($address) + { + return $this->setAddresses( + array_diff($this->getAddresses(), array($address)) + ); + } + + /** + * List of emails in merchant's profile. + * + * @param string[] $emails + * + * @return $this + */ + public function setEmails($emails) + { + $this->emails = $emails; + return $this; + } + + /** + * List of emails in merchant's profile. + * + * @return string[] + */ + public function getEmails() + { + return $this->emails; + } + + /** + * Append Emails to the list. + * + * @param string $string + * @return $this + */ + public function addEmail($string) + { + if (!$this->getEmails()) { + return $this->setEmails(array($string)); + } else { + return $this->setEmails( + array_merge($this->getEmails(), array($string)) + ); + } + } + + /** + * Remove Emails from the list. + * + * @param string $string + * @return $this + */ + public function removeEmail($string) + { + return $this->setEmails( + array_diff($this->getEmails(), array($string)) + ); + } + + /** + * List of phone numbers in merchant's profile. + * + * @param \PayPal\Api\Phone[] $phones + * + * @return $this + */ + public function setPhones($phones) + { + $this->phones = $phones; + return $this; + } + + /** + * List of phone numbers in merchant's profile. + * + * @return \PayPal\Api\Phone[] + */ + public function getPhones() + { + return $this->phones; + } + + /** + * Append Phones to the list. + * + * @param \PayPal\Api\Phone $phone + * @return $this + */ + public function addPhone($phone) + { + if (!$this->getPhones()) { + return $this->setPhones(array($phone)); + } else { + return $this->setPhones( + array_merge($this->getPhones(), array($phone)) + ); + } + } + + /** + * Remove Phones from the list. + * + * @param \PayPal\Api\Phone $phone + * @return $this + */ + public function removePhone($phone) + { + return $this->setPhones( + array_diff($this->getPhones(), array($phone)) + ); + } + + /** + * Array of templates. + * + * @param \PayPal\Api\Template[] $templates + * + * @return $this + */ + public function setTemplates($templates) + { + $this->templates = $templates; + return $this; + } + + /** + * Array of templates. + * + * @return \PayPal\Api\Template[] + */ + public function getTemplates() + { + return $this->templates; + } + + /** + * Append Templates to the list. + * + * @param \PayPal\Api\Template $template + * @return $this + */ + public function addTemplate($template) + { + if (!$this->getTemplates()) { + return $this->setTemplates(array($template)); + } else { + return $this->setTemplates( + array_merge($this->getTemplates(), array($template)) + ); + } + } + + /** + * Remove Templates from the list. + * + * @param \PayPal\Api\Template $template + * @return $this + */ + public function removeTemplate($template) + { + return $this->setTemplates( + array_diff($this->getTemplates(), array($template)) + ); + } + + /** + * Shows the details for a template, by ID. + * + * @param string $templateId + * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls + * @return Template + */ + public static function get($templateId, $apiContext = null, $restCall = null) + { + ArgumentValidator::validate($templateId, 'templateId'); + $payLoad = ""; + $json = self::executeCall( + "/v1/invoicing/templates/$templateId", + "GET", + $payLoad, + null, + $apiContext, + $restCall + ); + $ret = new Template(); + $ret->fromJson($json); + return $ret; + } + + /** + * Lists all templates for the merchant. + * + * @param array $params + * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls + * @return Templates + */ + public static function getAll($params, $apiContext = null, $restCall = null) + { + ArgumentValidator::validate($params, 'params'); + $payLoad = ""; + $allowedParams = array( + 'fields' => 1, + ); + $json = self::executeCall( + "/v1/invoicing/templates/" . "?" . http_build_query(array_intersect_key($params, $allowedParams)), + "GET", + $payLoad, + null, + $apiContext, + $restCall + ); + $ret = new Templates(); + $ret->fromJson($json); + return $ret; + } + +} diff --git a/sample/doc/assets/behavior.js b/sample/doc/assets/behavior.js index fc036de5..4508dc83 100644 --- a/sample/doc/assets/behavior.js +++ b/sample/doc/assets/behavior.js @@ -24,35 +24,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/CreateBillingAgreementWithCreditCard.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/CreateBillingAgreementWithCreditCard.php", "projectPath": "billing/CreateBillingAgreementWithCreditCard.php", "targetPath": "billing/CreateBillingAgreementWithCreditCard", "pageTitle": "billing/CreateBillingAgreementWithCreditCard", "title": "CreateBillingAgreementWithCreditCard" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Billing Agreement with Credit Card as Payment Source", - "slug": "create-billing-agreement-with-credit-card-as-payment-source" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Create Agreement", - "slug": "create-agreement" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -64,43 +42,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/CreateBillingAgreementWithPayPal.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/CreateBillingAgreementWithPayPal.php", "projectPath": "billing/CreateBillingAgreementWithPayPal.php", "targetPath": "billing/CreateBillingAgreementWithPayPal", "pageTitle": "billing/CreateBillingAgreementWithPayPal", "title": "CreateBillingAgreementWithPayPal" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Billing Agreement with PayPal as Payment Source", - "slug": "create-billing-agreement-with-paypal-as-payment-source" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Create Agreement", - "slug": "create-agreement" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Get redirect url", - "slug": "get-redirect-url" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -112,51 +60,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/CreatePlan.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/CreatePlan.php", "projectPath": "billing/CreatePlan.php", "targetPath": "billing/CreatePlan", "pageTitle": "billing/CreatePlan", "title": "CreatePlan" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Plan Sample", - "slug": "create-plan-sample" - }, - "depth": 1 - }, { - "type": "heading", - "data": { - "level": 1, - "title": "Basic Information", - "slug": "basic-information" - }, - "depth": 1 - }, { - "type": "heading", - "data": { - "level": 1, - "title": "Payment definitions for this billing plan.", - "slug": "payment-definitions-for-this-billing-plan" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Create Plan", - "slug": "create-plan" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -168,24 +78,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/DeletePlan.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/DeletePlan.php", "projectPath": "billing/DeletePlan.php", "targetPath": "billing/DeletePlan", "pageTitle": "billing/DeletePlan", "title": "DeletePlan" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Delete Plan Sample", - "slug": "delete-plan-sample" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -197,51 +96,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/ExecuteAgreement.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/ExecuteAgreement.php", "projectPath": "billing/ExecuteAgreement.php", "targetPath": "billing/ExecuteAgreement", "pageTitle": "billing/ExecuteAgreement", "title": "ExecuteAgreement" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Execute Agreement", - "slug": "execute-agreement" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Approval Status", - "slug": "approval-status" - }, - "depth": 2 - }, { - "type": "heading", - "data": { - "level": 2, - "title": "Execute Agreement", - "slug": "execute-agreement" - }, - "depth": 2 - }, { - "type": "heading", - "data": { - "level": 2, - "title": "Get Agreement", - "slug": "get-agreement" - }, - "depth": 2 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -253,24 +114,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/GetBillingAgreement.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/GetBillingAgreement.php", "projectPath": "billing/GetBillingAgreement.php", "targetPath": "billing/GetBillingAgreement", "pageTitle": "billing/GetBillingAgreement", "title": "GetBillingAgreement" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Billing Agreement Sample", - "slug": "get-billing-agreement-sample" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -282,24 +132,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/GetPlan.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/GetPlan.php", "projectPath": "billing/GetPlan.php", "targetPath": "billing/GetPlan", "pageTitle": "billing/GetPlan", "title": "GetPlan" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Plan Sample", - "slug": "get-plan-sample" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -311,24 +150,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/ListPlans.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/ListPlans.php", "projectPath": "billing/ListPlans.php", "targetPath": "billing/ListPlans", "pageTitle": "billing/ListPlans", "title": "ListPlans" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get List of Plan Sample", - "slug": "get-list-of-plan-sample" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -340,24 +168,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/ReactivateBillingAgreement.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/ReactivateBillingAgreement.php", "projectPath": "billing/ReactivateBillingAgreement.php", "targetPath": "billing/ReactivateBillingAgreement", "pageTitle": "billing/ReactivateBillingAgreement", "title": "ReactivateBillingAgreement" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Reactivate an agreement", - "slug": "reactivate-an-agreement" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -369,24 +186,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/SearchBillingTransactions.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/SearchBillingTransactions.php", "projectPath": "billing/SearchBillingTransactions.php", "targetPath": "billing/SearchBillingTransactions", "pageTitle": "billing/SearchBillingTransactions", "title": "SearchBillingTransactions" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Search Billing Transactions Sample", - "slug": "search-billing-transactions-sample" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -398,24 +204,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/SuspendBillingAgreement.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/SuspendBillingAgreement.php", "projectPath": "billing/SuspendBillingAgreement.php", "targetPath": "billing/SuspendBillingAgreement", "pageTitle": "billing/SuspendBillingAgreement", "title": "SuspendBillingAgreement" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Suspend an agreement", - "slug": "suspend-an-agreement" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -427,24 +222,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/UpdateBillingAgreement.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/UpdateBillingAgreement.php", "projectPath": "billing/UpdateBillingAgreement.php", "targetPath": "billing/UpdateBillingAgreement", "pageTitle": "billing/UpdateBillingAgreement", "title": "UpdateBillingAgreement" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Update an agreement", - "slug": "update-an-agreement" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -456,35 +240,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/UpdatePlan.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/UpdatePlan.php", "projectPath": "billing/UpdatePlan.php", "targetPath": "billing/UpdatePlan", "pageTitle": "billing/UpdatePlan", "title": "UpdatePlan" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Update a plan", - "slug": "update-a-plan" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Making Plan Active", - "slug": "making-plan-active" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -496,35 +258,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/billing/UpdatePlanPaymentDefinitions.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/billing/UpdatePlanPaymentDefinitions.php", "projectPath": "billing/UpdatePlanPaymentDefinitions.php", "targetPath": "billing/UpdatePlanPaymentDefinitions", "pageTitle": "billing/UpdatePlanPaymentDefinitions", "title": "UpdatePlanPaymentDefinitions" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Update a plan", - "slug": "update-a-plan" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Changing Plan Amount", - "slug": "changing-plan-amount" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 } ] }, { @@ -546,43 +286,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/CancelInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/CancelInvoice.php", "projectPath": "invoice/CancelInvoice.php", "targetPath": "invoice/CancelInvoice", "pageTitle": "invoice/CancelInvoice", "title": "CancelInvoice" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Cancel Invoice Sample", - "slug": "cancel-invoice-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Cancel Notification Object", - "slug": "cancel-notification-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Cancel Invoice", - "slug": "cancel-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -594,7 +304,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/CreateInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/CreateInvoice.php", "projectPath": "invoice/CreateInvoice.php", "targetPath": "invoice/CreateInvoice", "pageTitle": "invoice/CreateInvoice", @@ -717,91 +427,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/CreateThirdPartyInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/CreateThirdPartyInvoice.php", "projectPath": "invoice/CreateThirdPartyInvoice.php", "targetPath": "invoice/CreateThirdPartyInvoice", "pageTitle": "invoice/CreateThirdPartyInvoice", "title": "CreateThirdPartyInvoice" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Third Party Invoice Sample", - "slug": "create-third-party-invoice-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Invoice Info", - "slug": "invoice-info" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Merchant Info", - "slug": "merchant-info" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Address Information", - "slug": "address-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Billing Information", - "slug": "billing-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Items List", - "slug": "items-list" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Invoice", - "slug": "create-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Send Invoice", - "slug": "send-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Send Invoice", - "slug": "send-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -813,35 +445,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/DeleteInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/DeleteInvoice.php", "projectPath": "invoice/DeleteInvoice.php", "targetPath": "invoice/DeleteInvoice", "pageTitle": "invoice/DeleteInvoice", "title": "DeleteInvoice" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Delete Invoice Sample", - "slug": "delete-invoice-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Delete Invoice", - "slug": "delete-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -853,20 +463,38 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/GetInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/GetInvoice.php", "projectPath": "invoice/GetInvoice.php", "targetPath": "invoice/GetInvoice", "pageTitle": "invoice/GetInvoice", "title": "GetInvoice" }, + "depth": 2 + }, { + "type": "file", + "data": { + "language": { + "nameMatchers": [{}, ".fbp"], + "pygmentsLexer": "php", + "singleLineComment": ["//"], + "ignorePrefix": "}", + "foldPrefix": "^", + "name": "PHP" + }, + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/GetNextInvoiceNumber.php", + "projectPath": "invoice/GetNextInvoiceNumber.php", + "targetPath": "invoice/GetNextInvoiceNumber", + "pageTitle": "invoice/GetNextInvoiceNumber", + "title": "GetNextInvoiceNumber" + }, "depth": 2, "outline": [ { "type": "heading", "data": { "level": 1, - "title": "Get Invoice Sample", - "slug": "get-invoice-sample" + "title": "Get Next Invoice Number Sample", + "slug": "get-next-invoice-number-sample" }, "depth": 1, "children": [ @@ -874,8 +502,8 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "type": "heading", "data": { "level": 3, - "title": "Retrieve Invoice", - "slug": "retrieve-invoice" + "title": "Get Next Invoice Number", + "slug": "get-next-invoice-number" }, "depth": 3 } @@ -893,35 +521,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/ListInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/ListInvoice.php", "projectPath": "invoice/ListInvoice.php", "targetPath": "invoice/ListInvoice", "pageTitle": "invoice/ListInvoice", "title": "ListInvoice" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "List Invoices Sample", - "slug": "list-invoices-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve Invoices", - "slug": "retrieve-invoices" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -933,51 +539,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/RecordPayment.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/RecordPayment.php", "projectPath": "invoice/RecordPayment.php", "targetPath": "invoice/RecordPayment", "pageTitle": "invoice/RecordPayment", "title": "RecordPayment" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Record Payment Sample", - "slug": "record-payment-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Record Object", - "slug": "record-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Record Payment for Invoice", - "slug": "record-payment-for-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve Invoice", - "slug": "retrieve-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -989,51 +557,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/RecordRefund.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/RecordRefund.php", "projectPath": "invoice/RecordRefund.php", "targetPath": "invoice/RecordRefund", "pageTitle": "invoice/RecordRefund", "title": "RecordRefund" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Record Refund Sample", - "slug": "record-refund-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Record Object", - "slug": "record-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Record Refund for Invoice", - "slug": "record-refund-for-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve Invoice", - "slug": "retrieve-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1045,51 +575,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/RemindInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/RemindInvoice.php", "projectPath": "invoice/RemindInvoice.php", "targetPath": "invoice/RemindInvoice", "pageTitle": "invoice/RemindInvoice", "title": "RemindInvoice" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Remind Invoice Sample", - "slug": "remind-invoice-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Notification Object", - "slug": "notification-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Remind Invoice", - "slug": "remind-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve Invoice", - "slug": "retrieve-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1101,51 +593,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/RetrieveQRCode.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/RetrieveQRCode.php", "projectPath": "invoice/RetrieveQRCode.php", "targetPath": "invoice/RetrieveQRCode", "pageTitle": "invoice/RetrieveQRCode", "title": "RetrieveQRCode" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Retrieve QR Code for Invoice Sample", - "slug": "retrieve-qr-code-for-invoice-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve QR Code of Sent Invoice", - "slug": "retrieve-qr-code-of-sent-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Optionally Save to File", - "slug": "optionally-save-to-file" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Show the Image", - "slug": "show-the-image" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1157,43 +611,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/SearchInvoices.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/SearchInvoices.php", "projectPath": "invoice/SearchInvoices.php", "targetPath": "invoice/SearchInvoices", "pageTitle": "invoice/SearchInvoices", "title": "SearchInvoices" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Search Invoices Sample", - "slug": "search-invoices-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Search Object", - "slug": "search-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Search Invoices", - "slug": "search-invoices" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1205,43 +629,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/SendInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/SendInvoice.php", "projectPath": "invoice/SendInvoice.php", "targetPath": "invoice/SendInvoice", "pageTitle": "invoice/SendInvoice", "title": "SendInvoice" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Invoice Sample", - "slug": "create-invoice-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Send Invoice", - "slug": "send-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve Invoice", - "slug": "retrieve-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1253,59 +647,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/invoice/UpdateInvoice.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/invoice/UpdateInvoice.php", "projectPath": "invoice/UpdateInvoice.php", "targetPath": "invoice/UpdateInvoice", "pageTitle": "invoice/UpdateInvoice", "title": "UpdateInvoice" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Update Invoice Sample", - "slug": "update-invoice-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Update Invoice", - "slug": "update-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "NOTE: These are the work-around added to the", - "slug": "note-these-are-the-work-around-added-to-the" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Update Invoice", - "slug": "update-invoice" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve Invoice", - "slug": "retrieve-invoice" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 } ] }, { @@ -1327,24 +675,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/lipp/GenerateAccessTokenFromRefreshToken.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/lipp/GenerateAccessTokenFromRefreshToken.php", "projectPath": "lipp/GenerateAccessTokenFromRefreshToken.php", "targetPath": "lipp/GenerateAccessTokenFromRefreshToken", "pageTitle": "lipp/GenerateAccessTokenFromRefreshToken", "title": "GenerateAccessTokenFromRefreshToken" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Obtain Access Token From Refresh Token", - "slug": "obtain-access-token-from-refresh-token" - }, - "depth": 3 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1356,7 +693,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/lipp/GetUserInfo.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/lipp/GetUserInfo.php", "projectPath": "lipp/GetUserInfo.php", "targetPath": "lipp/GetUserInfo", "pageTitle": "lipp/GetUserInfo", @@ -1385,24 +722,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/lipp/ObtainUserConsent.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/lipp/ObtainUserConsent.php", "projectPath": "lipp/ObtainUserConsent.php", "targetPath": "lipp/ObtainUserConsent", "pageTitle": "lipp/ObtainUserConsent", "title": "ObtainUserConsent" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get User Consent URL", - "slug": "get-user-consent-url" - }, - "depth": 3 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1414,7 +740,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/lipp/UserConsentRedirect.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/lipp/UserConsentRedirect.php", "projectPath": "lipp/UserConsentRedirect.php", "targetPath": "lipp/UserConsentRedirect", "pageTitle": "lipp/UserConsentRedirect", @@ -1453,62 +779,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/CreateWebhook.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/CreateWebhook.php", "projectPath": "notifications/CreateWebhook.php", "targetPath": "notifications/CreateWebhook", "pageTitle": "notifications/CreateWebhook", "title": "CreateWebhook" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Webhook Sample", - "slug": "create-webhook-sample" - }, - "depth": 1 - }, { - "type": "heading", - "data": { - "level": 1, - "title": "Basic Information", - "slug": "basic-information" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "NOTE: Please note that you need an https url for paypal webhooks. You can however override the url with https, and accept", - "slug": "note-please-note-that-you-need-an-https-url-for-paypal-webhooks-you-can-however-override-the-url-with-https-and-accept" - }, - "depth": 4 - } - ] - }, { - "type": "heading", - "data": { - "level": 1, - "title": "Event Types", - "slug": "event-types" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Create Webhook", - "slug": "create-webhook" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1520,46 +797,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/DeleteAllWebhooks.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/DeleteAllWebhooks.php", "projectPath": "notifications/DeleteAllWebhooks.php", "targetPath": "notifications/DeleteAllWebhooks", "pageTitle": "notifications/DeleteAllWebhooks", "title": "DeleteAllWebhooks" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Delete All Webhook Sample", - "slug": "delete-all-webhook-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Get Webhook Instance", - "slug": "get-webhook-instance" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Delete Webhook", - "slug": "delete-webhook" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1571,46 +815,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/DeleteWebhook.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/DeleteWebhook.php", "projectPath": "notifications/DeleteWebhook.php", "targetPath": "notifications/DeleteWebhook", "pageTitle": "notifications/DeleteWebhook", "title": "DeleteWebhook" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Delete Webhook Sample", - "slug": "delete-webhook-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Get Webhook Instance", - "slug": "get-webhook-instance" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Delete Webhook", - "slug": "delete-webhook" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1622,46 +833,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/GetWebhook.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/GetWebhook.php", "projectPath": "notifications/GetWebhook.php", "targetPath": "notifications/GetWebhook", "pageTitle": "notifications/GetWebhook", "title": "GetWebhook" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Webhook Sample", - "slug": "get-webhook-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Get Webhook ID.", - "slug": "get-webhook-id" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get Webhook", - "slug": "get-webhook" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1673,46 +851,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/ListSubscribedWebhookEventTypes.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/ListSubscribedWebhookEventTypes.php", "projectPath": "notifications/ListSubscribedWebhookEventTypes.php", "targetPath": "notifications/ListSubscribedWebhookEventTypes", "pageTitle": "notifications/ListSubscribedWebhookEventTypes", "title": "ListSubscribedWebhookEventTypes" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Webhook Sample", - "slug": "get-webhook-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "List Subscribed Event Types", - "slug": "list-subscribed-event-types" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get List of Subscribed Event Types", - "slug": "get-list-of-subscribed-event-types" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1724,46 +869,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/ListWebhooks.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/ListWebhooks.php", "projectPath": "notifications/ListWebhooks.php", "targetPath": "notifications/ListWebhooks", "pageTitle": "notifications/ListWebhooks", "title": "ListWebhooks" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get All Webhooks Sample", - "slug": "get-all-webhooks-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "List Webhooks", - "slug": "list-webhooks" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get List of All Webhooks", - "slug": "get-list-of-all-webhooks" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1775,54 +887,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/SearchWebhookEvents.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/SearchWebhookEvents.php", "projectPath": "notifications/SearchWebhookEvents.php", "targetPath": "notifications/SearchWebhookEvents", "pageTitle": "notifications/SearchWebhookEvents", "title": "SearchWebhookEvents" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Search Webhook Events Sample", - "slug": "search-webhook-events-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Get Webhook Instance", - "slug": "get-webhook-instance" - }, - "depth": 2 - }, { - "type": "heading", - "data": { - "level": 2, - "title": "PLEASE NOTE:", - "slug": "please-note" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Search Webhook events", - "slug": "search-webhook-events" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1834,46 +905,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/UpdateWebhook.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/UpdateWebhook.php", "projectPath": "notifications/UpdateWebhook.php", "targetPath": "notifications/UpdateWebhook", "pageTitle": "notifications/UpdateWebhook", "title": "UpdateWebhook" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Update Webhook Sample", - "slug": "update-webhook-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Get Webhook ID.", - "slug": "get-webhook-id" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get Webhook", - "slug": "get-webhook" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1885,46 +923,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/ValidateWebhookEvent.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/ValidateWebhookEvent.php", "projectPath": "notifications/ValidateWebhookEvent.php", "targetPath": "notifications/ValidateWebhookEvent", "pageTitle": "notifications/ValidateWebhookEvent", "title": "ValidateWebhookEvent" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Validate Webhook", - "slug": "validate-webhook" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Received Body from Webhook", - "slug": "received-body-from-webhook" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Validate Received Event Method", - "slug": "validate-received-event-method" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -1936,35 +941,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/notifications/WebhookEventTypesList.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/notifications/WebhookEventTypesList.php", "projectPath": "notifications/WebhookEventTypesList.php", "targetPath": "notifications/WebhookEventTypesList", "pageTitle": "notifications/WebhookEventTypesList", "title": "WebhookEventTypesList" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Reference List of all Webhook Event Types", - "slug": "get-reference-list-of-all-webhook-event-types" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get List of all Webhook event types", - "slug": "get-list-of-all-webhook-event-types" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 } ] }, { @@ -1986,35 +969,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payment-experience/CreateWebProfile.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payment-experience/CreateWebProfile.php", "projectPath": "payment-experience/CreateWebProfile.php", "targetPath": "payment-experience/CreateWebProfile", "pageTitle": "payment-experience/CreateWebProfile", "title": "CreateWebProfile" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Create Web Profile", - "slug": "create-web-profile" - }, - "depth": 3, - "children": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "Payment Web experience profile resource", - "slug": "payment-web-experience-profile-resource" - }, - "depth": 4 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2026,24 +987,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payment-experience/DeleteWebProfile.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payment-experience/DeleteWebProfile.php", "projectPath": "payment-experience/DeleteWebProfile.php", "targetPath": "payment-experience/DeleteWebProfile", "pageTitle": "payment-experience/DeleteWebProfile", "title": "DeleteWebProfile" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "Delete Web Profile", - "slug": "delete-web-profile" - }, - "depth": 4 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2055,24 +1005,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payment-experience/GetWebProfile.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payment-experience/GetWebProfile.php", "projectPath": "payment-experience/GetWebProfile.php", "targetPath": "payment-experience/GetWebProfile", "pageTitle": "payment-experience/GetWebProfile", "title": "GetWebProfile" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get Web Profile", - "slug": "get-web-profile" - }, - "depth": 3 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2084,24 +1023,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payment-experience/ListWebProfiles.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payment-experience/ListWebProfiles.php", "projectPath": "payment-experience/ListWebProfiles.php", "targetPath": "payment-experience/ListWebProfiles", "pageTitle": "payment-experience/ListWebProfiles", "title": "ListWebProfiles" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve List of All Web Profiles", - "slug": "retrieve-list-of-all-web-profiles" - }, - "depth": 3 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2113,32 +1041,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payment-experience/PartiallyUpdateWebProfile.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payment-experience/PartiallyUpdateWebProfile.php", "projectPath": "payment-experience/PartiallyUpdateWebProfile.php", "targetPath": "payment-experience/PartiallyUpdateWebProfile", "pageTitle": "payment-experience/PartiallyUpdateWebProfile", "title": "PartiallyUpdateWebProfile" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "Partially Update Web Profile", - "slug": "partially-update-web-profile" - }, - "depth": 4 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Patch Operation", - "slug": "create-patch-operation" - }, - "depth": 3 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2150,24 +1059,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payment-experience/UpdateWebProfile.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payment-experience/UpdateWebProfile.php", "projectPath": "payment-experience/UpdateWebProfile.php", "targetPath": "payment-experience/UpdateWebProfile", "pageTitle": "payment-experience/UpdateWebProfile", "title": "UpdateWebProfile" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "Update Web Profile", - "slug": "update-web-profile" - }, - "depth": 4 - } - ] + "depth": 2 } ] }, { @@ -2189,35 +1087,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/AuthorizationCapture.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/AuthorizationCapture.php", "projectPath": "payments/AuthorizationCapture.php", "targetPath": "payments/AuthorizationCapture", "pageTitle": "payments/AuthorizationCapture", "title": "AuthorizationCapture" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "AuthorizationCapture", - "slug": "authorizationcapture" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Capture Payment", - "slug": "capture-payment" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2229,7 +1105,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/AuthorizePayment.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/AuthorizePayment.php", "projectPath": "payments/AuthorizePayment.php", "targetPath": "payments/AuthorizePayment", "pageTitle": "payments/AuthorizePayment", @@ -2269,99 +1145,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/AuthorizePaymentUsingPayPal.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/AuthorizePaymentUsingPayPal.php", "projectPath": "payments/AuthorizePaymentUsingPayPal.php", "targetPath": "payments/AuthorizePaymentUsingPayPal", "pageTitle": "payments/AuthorizePaymentUsingPayPal", "title": "AuthorizePaymentUsingPayPal" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Authorize Payment using PayPal as payment method", - "slug": "authorize-payment-using-paypal-as-payment-method" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Payer", - "slug": "payer" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Itemized information", - "slug": "itemized-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Additional payment details", - "slug": "additional-payment-details" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Amount", - "slug": "amount" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Transaction", - "slug": "transaction" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Redirect urls", - "slug": "redirect-urls" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Payment", - "slug": "payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Payment", - "slug": "create-payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Get redirect url", - "slug": "get-redirect-url" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2373,7 +1163,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/CreateFuturePayment.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/CreateFuturePayment.php", "projectPath": "payments/CreateFuturePayment.php", "targetPath": "payments/CreateFuturePayment", "pageTitle": "payments/CreateFuturePayment", @@ -2461,7 +1251,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/CreatePayment.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/CreatePayment.php", "projectPath": "payments/CreatePayment.php", "targetPath": "payments/CreatePayment", "pageTitle": "payments/CreatePayment", @@ -2565,7 +1355,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/CreatePaymentUsingPayPal.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/CreatePaymentUsingPayPal.php", "projectPath": "payments/CreatePaymentUsingPayPal.php", "targetPath": "payments/CreatePaymentUsingPayPal", "pageTitle": "payments/CreatePaymentUsingPayPal", @@ -2669,7 +1459,7 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/CreatePaymentUsingSavedCard.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/CreatePaymentUsingSavedCard.php", "projectPath": "payments/CreatePaymentUsingSavedCard.php", "targetPath": "payments/CreatePaymentUsingSavedCard", "pageTitle": "payments/CreatePaymentUsingSavedCard", @@ -2773,51 +1563,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/ExecutePayment.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/ExecutePayment.php", "projectPath": "payments/ExecutePayment.php", "targetPath": "payments/ExecutePayment", "pageTitle": "payments/ExecutePayment", "title": "ExecutePayment" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Execute Payment Sample", - "slug": "execute-payment-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Approval Status", - "slug": "approval-status" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Payment Execute", - "slug": "payment-execute" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Optional Changes to Amount", - "slug": "optional-changes-to-amount" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2829,35 +1581,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/GetAuthorization.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/GetAuthorization.php", "projectPath": "payments/GetAuthorization.php", "targetPath": "payments/GetAuthorization", "pageTitle": "payments/GetAuthorization", "title": "GetAuthorization" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "GetAuthorization", - "slug": "getauthorization" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "GetAuthorization", - "slug": "getauthorization" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2869,35 +1599,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/GetCapture.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/GetCapture.php", "projectPath": "payments/GetCapture.php", "targetPath": "payments/GetCapture", "pageTitle": "payments/GetCapture", "title": "GetCapture" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "GetCapture", - "slug": "getcapture" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve Capture details", - "slug": "retrieve-capture-details" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2909,35 +1617,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/GetPayment.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/GetPayment.php", "projectPath": "payments/GetPayment.php", "targetPath": "payments/GetPayment", "pageTitle": "payments/GetPayment", "title": "GetPayment" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "GetPaymentSample", - "slug": "getpaymentsample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve payment", - "slug": "retrieve-payment" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2949,35 +1635,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/ListPayments.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/ListPayments.php", "projectPath": "payments/ListPayments.php", "targetPath": "payments/ListPayments", "pageTitle": "payments/ListPayments", "title": "ListPayments" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "GetPaymentList", - "slug": "getpaymentlist" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve payment", - "slug": "retrieve-payment" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -2989,59 +1653,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderAuthorize.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderAuthorize.php", "projectPath": "payments/OrderAuthorize.php", "targetPath": "payments/OrderAuthorize", "pageTitle": "payments/OrderAuthorize", "title": "OrderAuthorize" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Authorize Order Sample", - "slug": "authorize-order-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Approval Status", - "slug": "approval-status" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve the order", - "slug": "retrieve-the-order" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Authorization Object", - "slug": "create-authorization-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Authorize Order", - "slug": "authorize-order" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3053,59 +1671,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderCapture.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderCapture.php", "projectPath": "payments/OrderCapture.php", "targetPath": "payments/OrderCapture", "pageTitle": "payments/OrderCapture", "title": "OrderCapture" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Capture Order Sample", - "slug": "capture-order-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Approval Status", - "slug": "approval-status" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve the order", - "slug": "retrieve-the-order" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Capture Object", - "slug": "create-capture-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Capture Order", - "slug": "capture-order" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3117,99 +1689,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateForAuthorization.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateForAuthorization.php", "projectPath": "payments/OrderCreateForAuthorization.php", "targetPath": "payments/OrderCreateForAuthorization", "pageTitle": "payments/OrderCreateForAuthorization", "title": "OrderCreateForAuthorization" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Order Create Using PayPal", - "slug": "order-create-using-paypal" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Payer", - "slug": "payer" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Itemized information", - "slug": "itemized-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Additional payment details", - "slug": "additional-payment-details" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Amount", - "slug": "amount" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Transaction", - "slug": "transaction" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Redirect urls", - "slug": "redirect-urls" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Payment", - "slug": "payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Payment", - "slug": "create-payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Get redirect url", - "slug": "get-redirect-url" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3221,99 +1707,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateForCapture.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateForCapture.php", "projectPath": "payments/OrderCreateForCapture.php", "targetPath": "payments/OrderCreateForCapture", "pageTitle": "payments/OrderCreateForCapture", "title": "OrderCreateForCapture" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Order Create Using PayPal", - "slug": "order-create-using-paypal" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Payer", - "slug": "payer" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Itemized information", - "slug": "itemized-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Additional payment details", - "slug": "additional-payment-details" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Amount", - "slug": "amount" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Transaction", - "slug": "transaction" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Redirect urls", - "slug": "redirect-urls" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Payment", - "slug": "payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Payment", - "slug": "create-payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Get redirect url", - "slug": "get-redirect-url" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3325,99 +1725,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateForVoid.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateForVoid.php", "projectPath": "payments/OrderCreateForVoid.php", "targetPath": "payments/OrderCreateForVoid", "pageTitle": "payments/OrderCreateForVoid", "title": "OrderCreateForVoid" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Order Create Using PayPal", - "slug": "order-create-using-paypal" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Payer", - "slug": "payer" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Itemized information", - "slug": "itemized-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Additional payment details", - "slug": "additional-payment-details" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Amount", - "slug": "amount" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Transaction", - "slug": "transaction" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Redirect urls", - "slug": "redirect-urls" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Payment", - "slug": "payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Payment", - "slug": "create-payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Get redirect url", - "slug": "get-redirect-url" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3429,99 +1743,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateUsingPayPal.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderCreateUsingPayPal.php", "projectPath": "payments/OrderCreateUsingPayPal.php", "targetPath": "payments/OrderCreateUsingPayPal", "pageTitle": "payments/OrderCreateUsingPayPal", "title": "OrderCreateUsingPayPal" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Order Create Using PayPal", - "slug": "order-create-using-paypal" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Payer", - "slug": "payer" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Itemized information", - "slug": "itemized-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Additional payment details", - "slug": "additional-payment-details" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Amount", - "slug": "amount" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Transaction", - "slug": "transaction" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Redirect urls", - "slug": "redirect-urls" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Payment", - "slug": "payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Payment", - "slug": "create-payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Get redirect url", - "slug": "get-redirect-url" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3533,51 +1761,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderDoVoid.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderDoVoid.php", "projectPath": "payments/OrderDoVoid.php", "targetPath": "payments/OrderDoVoid", "pageTitle": "payments/OrderDoVoid", "title": "OrderDoVoid" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Void Order Sample", - "slug": "void-order-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Approval Status", - "slug": "approval-status" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve the order", - "slug": "retrieve-the-order" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Void Order", - "slug": "void-order" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3589,35 +1779,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/OrderGet.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/OrderGet.php", "projectPath": "payments/OrderGet.php", "targetPath": "payments/OrderGet", "pageTitle": "payments/OrderGet", "title": "OrderGet" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Order Sample", - "slug": "get-order-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Approval Status", - "slug": "approval-status" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3629,43 +1797,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/Reauthorization.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/Reauthorization.php", "projectPath": "payments/Reauthorization.php", "targetPath": "payments/Reauthorization", "pageTitle": "payments/Reauthorization", "title": "Reauthorization" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Reauthorization Sample", - "slug": "reauthorization-sample" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Reauthorization", - "slug": "reauthorization" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Reauthorize with amount being reauthorized", - "slug": "reauthorize-with-amount-being-reauthorized" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3677,35 +1815,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/RefundCapture.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/RefundCapture.php", "projectPath": "payments/RefundCapture.php", "targetPath": "payments/RefundCapture", "pageTitle": "payments/RefundCapture", "title": "RefundCapture" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Refund Capture Sample", - "slug": "refund-capture-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Refund", - "slug": "refund" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3717,70 +1833,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/UpdatePayment.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/UpdatePayment.php", "projectPath": "payments/UpdatePayment.php", "targetPath": "payments/UpdatePayment", "pageTitle": "payments/UpdatePayment", "title": "UpdatePayment" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Update Payment Sample", - "slug": "update-payment-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "NOTE", - "slug": "note" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "Create a Patch Request", - "slug": "create-a-patch-request" - }, - "depth": 4 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Update payment", - "slug": "update-payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Getting Updated Payment Object", - "slug": "getting-updated-payment-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Get redirect url", - "slug": "get-redirect-url" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3792,35 +1851,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payments/VoidAuthorization.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payments/VoidAuthorization.php", "projectPath": "payments/VoidAuthorization.php", "targetPath": "payments/VoidAuthorization", "pageTitle": "payments/VoidAuthorization", "title": "VoidAuthorization" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "VoidAuthorization", - "slug": "voidauthorization" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "VoidAuthorization", - "slug": "voidauthorization" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 } ] }, { @@ -3842,46 +1879,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payouts/CancelPayoutItem.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payouts/CancelPayoutItem.php", "projectPath": "payouts/CancelPayoutItem.php", "targetPath": "payouts/CancelPayoutItem", "pageTitle": "payouts/CancelPayoutItem", "title": "CancelPayoutItem" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Cancel Payout Item Status Sample", - "slug": "cancel-payout-item-status-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Payout Item ID", - "slug": "payout-item-id" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Cancel Payout Item", - "slug": "cancel-payout-item" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3893,78 +1897,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payouts/CreateBatchPayout.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payouts/CreateBatchPayout.php", "projectPath": "payouts/CreateBatchPayout.php", "targetPath": "payouts/CreateBatchPayout", "pageTitle": "payouts/CreateBatchPayout", "title": "CreateBatchPayout" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Bulk Payout Sample", - "slug": "create-bulk-payout-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "NOTE:", - "slug": "note" - }, - "depth": 3, - "children": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "Batch Header Instance", - "slug": "batch-header-instance" - }, - "depth": 4 - }, { - "type": "heading", - "data": { - "level": 4, - "title": "Sender Item", - "slug": "sender-item" - }, - "depth": 4 - }, { - "type": "heading", - "data": { - "level": 4, - "title": "Sender Item 2", - "slug": "sender-item-2" - }, - "depth": 4 - }, { - "type": "heading", - "data": { - "level": 4, - "title": "Sender Item 3", - "slug": "sender-item-3" - }, - "depth": 4 - } - ] - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Payout", - "slug": "create-payout" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -3976,62 +1915,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payouts/CreateSinglePayout.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payouts/CreateSinglePayout.php", "projectPath": "payouts/CreateSinglePayout.php", "targetPath": "payouts/CreateSinglePayout", "pageTitle": "payouts/CreateSinglePayout", "title": "CreateSinglePayout" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Single Synchronous Payout Sample", - "slug": "create-single-synchronous-payout-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "NOTE:", - "slug": "note" - }, - "depth": 3, - "children": [ - { - "type": "heading", - "data": { - "level": 4, - "title": "Batch Header Instance", - "slug": "batch-header-instance" - }, - "depth": 4 - }, { - "type": "heading", - "data": { - "level": 4, - "title": "Sender Item", - "slug": "sender-item" - }, - "depth": 4 - } - ] - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Create Payout", - "slug": "create-payout" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4043,97 +1933,31 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payouts/GetPayoutBatchStatus.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payouts/GetPayoutBatchStatus.php", "projectPath": "payouts/GetPayoutBatchStatus.php", "targetPath": "payouts/GetPayoutBatchStatus", "pageTitle": "payouts/GetPayoutBatchStatus", "title": "GetPayoutBatchStatus" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Payout Batch Status Sample", - "slug": "get-payout-batch-status-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Payout Batch ID", - "slug": "payout-batch-id" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get Payout Batch Status", - "slug": "get-payout-batch-status" - }, - "depth": 3 - } - ] - } - ] - } - ] - }, { - "type": "file", - "data": { - "language": { - "nameMatchers": [{}, ".fbp"], - "pygmentsLexer": "php", - "singleLineComment": ["//"], - "ignorePrefix": "}", - "foldPrefix": "^", - "name": "PHP" - }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/payouts/GetPayoutItemStatus.php", - "projectPath": "payouts/GetPayoutItemStatus.php", - "targetPath": "payouts/GetPayoutItemStatus", - "pageTitle": "payouts/GetPayoutItemStatus", - "title": "GetPayoutItemStatus" - }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Payout Item Status Sample", - "slug": "get-payout-item-status-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "Payout Item ID", - "slug": "payout-item-id" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get Payout Item Status", - "slug": "get-payout-item-status" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 + }, { + "type": "file", + "data": { + "language": { + "nameMatchers": [{}, ".fbp"], + "pygmentsLexer": "php", + "singleLineComment": ["//"], + "ignorePrefix": "}", + "foldPrefix": "^", + "name": "PHP" + }, + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/payouts/GetPayoutItemStatus.php", + "projectPath": "payouts/GetPayoutItemStatus.php", + "targetPath": "payouts/GetPayoutItemStatus", + "pageTitle": "payouts/GetPayoutItemStatus", + "title": "GetPayoutItemStatus" + }, + "depth": 2 } ] }, { @@ -4155,43 +1979,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/sale/GetSale.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/sale/GetSale.php", "projectPath": "sale/GetSale.php", "targetPath": "sale/GetSale", "pageTitle": "sale/GetSale", "title": "GetSale" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Sale sample", - "slug": "get-sale-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Get Sale From Created Payment", - "slug": "get-sale-from-created-payment" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Retrieve the sale object", - "slug": "retrieve-the-sale-object" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4203,51 +1997,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/sale/RefundSale.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/sale/RefundSale.php", "projectPath": "sale/RefundSale.php", "targetPath": "sale/RefundSale", "pageTitle": "sale/RefundSale", "title": "RefundSale" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Sale Refund Sample", - "slug": "sale-refund-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Refund amount", - "slug": "refund-amount" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Refund object", - "slug": "refund-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Sale", - "slug": "sale" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 } ] }, { @@ -4269,46 +2025,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/tls/TlsCheck.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/tls/TlsCheck.php", "projectPath": "tls/TlsCheck.php", "targetPath": "tls/TlsCheck", "pageTitle": "tls/TlsCheck", "title": "TlsCheck" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Payment using PayPal as payment method", - "slug": "create-payment-using-paypal-as-payment-method" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 2, - "title": "TLS Check", - "slug": "tls-check" - }, - "depth": 2, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Create a Payment for testing", - "slug": "create-a-payment-for-testing" - }, - "depth": 3 - } - ] - } - ] - } - ] + "depth": 2 } ] }, { @@ -4330,43 +2053,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/CreateBankAccount.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/CreateBankAccount.php", "projectPath": "vault/CreateBankAccount.php", "targetPath": "vault/CreateBankAccount", "pageTitle": "vault/CreateBankAccount", "title": "CreateBankAccount" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Bank Account Sample", - "slug": "create-bank-account-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Bank Account", - "slug": "bank-account" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Save bank account", - "slug": "save-bank-account" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4378,51 +2071,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/CreateCreditCard.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/CreateCreditCard.php", "projectPath": "vault/CreateCreditCard.php", "targetPath": "vault/CreateCreditCard", "pageTitle": "vault/CreateCreditCard", "title": "CreateCreditCard" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Create Credit Card Sample", - "slug": "create-credit-card-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "CreditCard", - "slug": "creditcard" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Additional Information", - "slug": "additional-information" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Save card", - "slug": "save-card" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4434,35 +2089,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/DeleteBankAccount.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/DeleteBankAccount.php", "projectPath": "vault/DeleteBankAccount.php", "targetPath": "vault/DeleteBankAccount", "pageTitle": "vault/DeleteBankAccount", "title": "DeleteBankAccount" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Delete Bank Account Sample", - "slug": "delete-bank-account-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Delete Card", - "slug": "delete-card" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4474,35 +2107,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/DeleteCreditCard.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/DeleteCreditCard.php", "projectPath": "vault/DeleteCreditCard.php", "targetPath": "vault/DeleteCreditCard", "pageTitle": "vault/DeleteCreditCard", "title": "DeleteCreditCard" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Delete CreditCard Sample", - "slug": "delete-creditcard-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Delete Card", - "slug": "delete-card" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4514,24 +2125,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/GetBankAccount.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/GetBankAccount.php", "projectPath": "vault/GetBankAccount.php", "targetPath": "vault/GetBankAccount", "pageTitle": "vault/GetBankAccount", "title": "GetBankAccount" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Bank Account Sample", - "slug": "get-bank-account-sample" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4543,24 +2143,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/GetCreditCard.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/GetCreditCard.php", "projectPath": "vault/GetCreditCard.php", "targetPath": "vault/GetCreditCard", "pageTitle": "vault/GetCreditCard", "title": "GetCreditCard" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Get Credit Card Sample", - "slug": "get-credit-card-sample" - }, - "depth": 1 - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4572,35 +2161,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/ListCreditCards.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/ListCreditCards.php", "projectPath": "vault/ListCreditCards.php", "targetPath": "vault/ListCreditCards", "pageTitle": "vault/ListCreditCards", "title": "ListCreditCards" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "List Credit Card Sample", - "slug": "list-credit-card-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Parameters to Filter", - "slug": "parameters-to-filter" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 }, { "type": "file", "data": { @@ -4612,43 +2179,13 @@ f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3 "foldPrefix": "^", "name": "PHP" }, - "sourcePath": "/home/travis/build/paypal/PayPal-PHP-SDK/sample/vault/UpdateCreditCard.php", + "sourcePath": "/Users/japatel/Documents/workspace/paypal/PayPal-PHP-SDK/sample/vault/UpdateCreditCard.php", "projectPath": "vault/UpdateCreditCard.php", "targetPath": "vault/UpdateCreditCard", "pageTitle": "vault/UpdateCreditCard", "title": "UpdateCreditCard" }, - "depth": 2, - "outline": [ - { - "type": "heading", - "data": { - "level": 1, - "title": "Update Credit Card Sample", - "slug": "update-credit-card-sample" - }, - "depth": 1, - "children": [ - { - "type": "heading", - "data": { - "level": 3, - "title": "Patch Object", - "slug": "patch-object" - }, - "depth": 3 - }, { - "type": "heading", - "data": { - "level": 3, - "title": "Another Patch Object", - "slug": "another-patch-object" - }, - "depth": 3 - } - ] - } - ] + "depth": 2 } ] } diff --git a/sample/doc/invoice/GetNextInvoiceNumber.html b/sample/doc/invoice/GetNextInvoiceNumber.html new file mode 100644 index 00000000..a24dd85d --- /dev/null +++ b/sample/doc/invoice/GetNextInvoiceNumber.html @@ -0,0 +1,12 @@ +invoice/GetNextInvoiceNumber
invoice/GetNextInvoiceNumber.php
<?php

Get Next Invoice Number Sample

+

This sample code demonstrate how you can retrieve +the next invoice number.

require '../bootstrap.php'; +use PayPal\Api\Invoice;

Get Next Invoice Number

+

To generate the successive invoice number for the merchant, use below code. +(See bootstrap.php for more on ApiContext)

try { + $number = Invoice::generateNumber($apiContext); +} catch (Exception $ex) {

NOTE: PLEASE DO NOT USE RESULTPRINTER CLASS IN YOUR ORIGINAL CODE. FOR SAMPLE ONLY

ResultPrinter::printError("Get Next Invoice Number", "InvoiceNumber", null, null, $ex); + exit(1); +}

NOTE: PLEASE DO NOT USE RESULTPRINTER CLASS IN YOUR ORIGINAL CODE. FOR SAMPLE ONLY

ResultPrinter::printResult("Get Next Invoice Number", "InvoiceNumber", null, $number, $number); + +return $number;
\ No newline at end of file diff --git a/sample/index.php b/sample/index.php index e4830ac1..daeb2d90 100644 --- a/sample/index.php +++ b/sample/index.php @@ -1186,6 +1186,17 @@ class="fa fa-file-code-o">