diff --git a/lib/PayPal/Api/Image.php b/lib/PayPal/Api/Image.php new file mode 100644 index 0000000..14109ce --- /dev/null +++ b/lib/PayPal/Api/Image.php @@ -0,0 +1,55 @@ +image = $imageBase64String; + return $this; + } + + /** + * Get Image as Base-64 encoded String + * + * @return string + */ + public function getImageBase64() + { + return $this->image; + } + + /** + * Stores the Image to file + * + * @param string $name File Name + */ + public function saveToFile($name = null) + { + // Self Generate File Location + if (!$name) { + $name = uniqid() . '.png'; + } + // Save to File + file_put_contents($name, base64_decode($this->getImageBase64())); + return $name; + } + +} diff --git a/lib/PayPal/Api/Invoice.php b/lib/PayPal/Api/Invoice.php index 4f2f425..7768a14 100644 --- a/lib/PayPal/Api/Invoice.php +++ b/lib/PayPal/Api/Invoice.php @@ -4,8 +4,6 @@ namespace PayPal\Api; use PayPal\Common\ResourceModel; use PayPal\Validation\ArgumentValidator; -use PayPal\Api\Invoices; -use PayPal\Api\object; use PayPal\Rest\ApiContext; use PayPal\Transport\PPRestCall; use PayPal\Validation\UrlValidator; @@ -1096,7 +1094,7 @@ class Invoice extends ResourceModel * @param Search $search * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param PPRestCall $restCall is the Rest Call Service that is used to make rest calls - * @return Invoices + * @return InvoiceSearchResponse */ public function search($search, $apiContext = null, $restCall = null) { @@ -1110,7 +1108,7 @@ class Invoice extends ResourceModel $apiContext, $restCall ); - $ret = new Invoices(); + $ret = new InvoiceSearchResponse(); $ret->fromJson($json); return $ret; } @@ -1261,26 +1259,49 @@ class Invoice extends ResourceModel /** * List some or all invoices for a merchant according to optional query string parameters specified. * + * @param array $params * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param PPRestCall $restCall is the Rest Call Service that is used to make rest calls - * @return Invoices + * @return InvoiceSearchResponse */ - public static function getAll($apiContext = null, $restCall = null) + public static function getAll($params = array(), $apiContext = null, $restCall = null) { + ArgumentValidator::validate($params, 'params'); + + $allowedParams = array( + 'page' => 1, + 'page_size' => 1, + 'total_count_required' => 1 + ); + $payLoad = ""; $json = self::executeCall( - "/v1/invoicing/invoices/", + "/v1/invoicing/invoices/?" . http_build_query(array_intersect_key($params, $allowedParams)), "GET", $payLoad, null, $apiContext, $restCall ); - $ret = new Invoices(); + $ret = new InvoiceSearchResponse(); $ret->fromJson($json); return $ret; } + /** + * @deprecated Use getAll instead + * + * List some or all invoices for a merchant according to optional query string parameters specified. + * + * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. + * @param PPRestCall $restCall is the Rest Call Service that is used to make rest calls + * @return InvoiceSearchResponse + */ + public static function get_all($apiContext = null, $restCall = null) + { + return self::getAll(null, $apiContext, $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. * @@ -1329,24 +1350,33 @@ class Invoice extends ResourceModel /** * Generate a QR code for an invoice by passing the invoice ID to the request URI. The request generates a QR code that is 500 pixels in width and height. You can change the dimensions of the returned code by specifying optional query parameters. * + * @param array $params * @param string $invoiceId * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials. * @param PPRestCall $restCall is the Rest Call Service that is used to make rest calls - * @return object + * @return Image */ - public static function qrCode($invoiceId, $apiContext = null, $restCall = null) + public static function qrCode($invoiceId, $params = array(), $apiContext = null, $restCall = null) { ArgumentValidator::validate($invoiceId, 'invoiceId'); + ArgumentValidator::validate($params, 'params'); + + $allowedParams = array( + 'width' => 1, + 'height' => 1, + 'action' => 1 + ); + $payLoad = ""; $json = self::executeCall( - "/v1/invoicing/invoices/$invoiceId/qr-code", + "/v1/invoicing/invoices/$invoiceId/qr-code?" . http_build_query(array_intersect_key($params, $allowedParams)), "GET", $payLoad, null, $apiContext, $restCall ); - $ret = new object(); + $ret = new Image(); $ret->fromJson($json); return $ret; } diff --git a/lib/PayPal/Api/Invoices.php b/lib/PayPal/Api/Invoices.php deleted file mode 100644 index e73c92c..0000000 --- a/lib/PayPal/Api/Invoices.php +++ /dev/null @@ -1,1066 +0,0 @@ -id = $id; - return $this; - } - - /** - * Unique invoice resource identifier. - * - * @return string - */ - public function getId() - { - return $this->id; - } - - /** - * Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max. - * - * @param string $number - * - * @return $this - */ - public function setNumber($number) - { - $this->number = $number; - return $this; - } - - /** - * Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max. - * - * @return string - */ - public function getNumber() - { - return $this->number; - } - - /** - * URI of the invoice resource. - * - * @param string $uri - * - * @return $this - */ - public function setUri($uri) - { - $this->uri = $uri; - return $this; - } - - /** - * URI of the invoice resource. - * - * @return string - */ - public function getUri() - { - return $this->uri; - } - - /** - * Status of the invoice. - * Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"] - * - * @param string $status - * - * @return $this - */ - public function setStatus($status) - { - $this->status = $status; - return $this; - } - - /** - * Status of the invoice. - * - * @return string - */ - public function getStatus() - { - return $this->status; - } - - /** - * Information about the merchant who is sending the invoice. - * - * @param \PayPal\Api\MerchantInfo $merchant_info - * - * @return $this - */ - public function setMerchantInfo($merchant_info) - { - $this->merchant_info = $merchant_info; - return $this; - } - - /** - * Information about the merchant who is sending the invoice. - * - * @return \PayPal\Api\MerchantInfo - */ - public function getMerchantInfo() - { - return $this->merchant_info; - } - - /** - * Information about the merchant who is sending the invoice. - * - * @deprecated Instead use setMerchantInfo - * - * @param \PayPal\Api\MerchantInfo $merchant_info - * @return $this - */ - public function setMerchant_info($merchant_info) - { - $this->merchant_info = $merchant_info; - return $this; - } - - /** - * Information about the merchant who is sending the invoice. - * @deprecated Instead use getMerchantInfo - * - * @return \PayPal\Api\MerchantInfo - */ - public function getMerchant_info() - { - return $this->merchant_info; - } - - /** - * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). - * - * @param \PayPal\Api\BillingInfo[] $billing_info - * - * @return $this - */ - public function setBillingInfo($billing_info) - { - $this->billing_info = $billing_info; - return $this; - } - - /** - * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). - * - * @return \PayPal\Api\BillingInfo[] - */ - public function getBillingInfo() - { - return $this->billing_info; - } - - /** - * 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)) - ); - } - - /** - * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). - * - * @deprecated Instead use setBillingInfo - * - * @param \PayPal\Api\BillingInfo $billing_info - * @return $this - */ - public function setBilling_info($billing_info) - { - $this->billing_info = $billing_info; - return $this; - } - - /** - * Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient). - * @deprecated Instead use getBillingInfo - * - * @return \PayPal\Api\BillingInfo - */ - public function getBilling_info() - { - return $this->billing_info; - } - - /** - * 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; - } - - /** - * Shipping information for entities to whom items are being shipped. - * - * @return \PayPal\Api\ShippingInfo - */ - public function getShippingInfo() - { - return $this->shipping_info; - } - - /** - * Shipping information for entities to whom items are being shipped. - * - * @deprecated Instead use setShippingInfo - * - * @param \PayPal\Api\ShippingInfo $shipping_info - * @return $this - */ - public function setShipping_info($shipping_info) - { - $this->shipping_info = $shipping_info; - return $this; - } - - /** - * Shipping information for entities to whom items are being shipped. - * @deprecated Instead use getShippingInfo - * - * @return \PayPal\Api\ShippingInfo - */ - public function getShipping_info() - { - return $this->shipping_info; - } - - /** - * List of items included in the invoice. 100 items max per invoice. - * - * @param \PayPal\Api\InvoiceItem[] $items - * - * @return $this - */ - public function setItems($items) - { - $this->items = $items; - return $this; - } - - /** - * List of items included in the invoice. 100 items max per invoice. - * - * @return \PayPal\Api\InvoiceItem[] - */ - public function getItems() - { - return $this->items; - } - - /** - * 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)) - ); - } - - /** - * 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). - * - * @param string $invoice_date - * - * @return $this - */ - public function setInvoiceDate($invoice_date) - { - $this->invoice_date = $invoice_date; - return $this; - } - - /** - * Date on which the invoice was enabled. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). - * - * @return string - */ - public function getInvoiceDate() - { - return $this->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). - * - * @deprecated Instead use setInvoiceDate - * - * @param string $invoice_date - * @return $this - */ - public function setInvoice_date($invoice_date) - { - $this->invoice_date = $invoice_date; - return $this; - } - - /** - * Date on which the invoice was enabled. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). - * @deprecated Instead use getInvoiceDate - * - * @return string - */ - public function getInvoice_date() - { - return $this->invoice_date; - } - - /** - * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. - * - * @param \PayPal\Api\PaymentTerm $payment_term - * - * @return $this - */ - public function setPaymentTerm($payment_term) - { - $this->payment_term = $payment_term; - return $this; - } - - /** - * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. - * - * @return \PayPal\Api\PaymentTerm - */ - public function getPaymentTerm() - { - return $this->payment_term; - } - - /** - * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. - * - * @deprecated Instead use setPaymentTerm - * - * @param \PayPal\Api\PaymentTerm $payment_term - * @return $this - */ - public function setPayment_term($payment_term) - { - $this->payment_term = $payment_term; - return $this; - } - - /** - * Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both. - * @deprecated Instead use getPaymentTerm - * - * @return \PayPal\Api\PaymentTerm - */ - public function getPayment_term() - { - return $this->payment_term; - } - - /** - * Invoice level discount in percent or amount. - * - * @param \PayPal\Api\Cost $discount - * - * @return $this - */ - public function setDiscount($discount) - { - $this->discount = $discount; - return $this; - } - - /** - * Invoice level discount in percent or amount. - * - * @return \PayPal\Api\Cost - */ - public function getDiscount() - { - return $this->discount; - } - - /** - * Shipping cost in percent or amount. - * - * @param \PayPal\Api\ShippingCost $shipping_cost - * - * @return $this - */ - public function setShippingCost($shipping_cost) - { - $this->shipping_cost = $shipping_cost; - return $this; - } - - /** - * Shipping cost in percent or amount. - * - * @return \PayPal\Api\ShippingCost - */ - public function getShippingCost() - { - return $this->shipping_cost; - } - - /** - * Shipping cost in percent or amount. - * - * @deprecated Instead use setShippingCost - * - * @param \PayPal\Api\ShippingCost $shipping_cost - * @return $this - */ - public function setShipping_cost($shipping_cost) - { - $this->shipping_cost = $shipping_cost; - return $this; - } - - /** - * Shipping cost in percent or amount. - * @deprecated Instead use getShippingCost - * - * @return \PayPal\Api\ShippingCost - */ - public function getShipping_cost() - { - return $this->shipping_cost; - } - - /** - * Custom amount applied on an invoice. If a label is included then the amount cannot be empty. - * - * @param \PayPal\Api\CustomAmount $custom - * - * @return $this - */ - public function setCustom($custom) - { - $this->custom = $custom; - return $this; - } - - /** - * Custom amount applied on an invoice. If a label is included then the amount cannot be empty. - * - * @return \PayPal\Api\CustomAmount - */ - public function getCustom() - { - return $this->custom; - } - - /** - * Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. - * - * @param 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 false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. - * - * @return bool - */ - public function getTaxCalculatedAfterDiscount() - { - return $this->tax_calculated_after_discount; - } - - /** - * Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. - * - * @deprecated Instead use setTaxCalculatedAfterDiscount - * - * @param bool $tax_calculated_after_discount - * @return $this - */ - public function setTax_calculated_after_discount($tax_calculated_after_discount) - { - $this->tax_calculated_after_discount = $tax_calculated_after_discount; - return $this; - } - - /** - * Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount. - * @deprecated Instead use getTaxCalculatedAfterDiscount - * - * @return bool - */ - public function getTax_calculated_after_discount() - { - return $this->tax_calculated_after_discount; - } - - /** - * A flag indicating whether the unit price includes tax. Default is false - * - * @param bool $tax_inclusive - * - * @return $this - */ - public function setTaxInclusive($tax_inclusive) - { - $this->tax_inclusive = $tax_inclusive; - return $this; - } - - /** - * A flag indicating whether the unit price includes tax. Default is false - * - * @return bool - */ - public function getTaxInclusive() - { - return $this->tax_inclusive; - } - - /** - * A flag indicating whether the unit price includes tax. Default is false - * - * @deprecated Instead use setTaxInclusive - * - * @param bool $tax_inclusive - * @return $this - */ - public function setTax_inclusive($tax_inclusive) - { - $this->tax_inclusive = $tax_inclusive; - return $this; - } - - /** - * A flag indicating whether the unit price includes tax. Default is false - * @deprecated Instead use getTaxInclusive - * - * @return bool - */ - public function getTax_inclusive() - { - 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; - } - - /** - * Bookkeeping memo that is private to the merchant. 150 characters max. - * - * @param string $merchant_memo - * - * @return $this - */ - public function setMerchantMemo($merchant_memo) - { - $this->merchant_memo = $merchant_memo; - return $this; - } - - /** - * Bookkeeping memo that is private to the merchant. 150 characters max. - * - * @return string - */ - public function getMerchantMemo() - { - return $this->merchant_memo; - } - - /** - * Bookkeeping memo that is private to the merchant. 150 characters max. - * - * @deprecated Instead use setMerchantMemo - * - * @param string $merchant_memo - * @return $this - */ - public function setMerchant_memo($merchant_memo) - { - $this->merchant_memo = $merchant_memo; - return $this; - } - - /** - * Bookkeeping memo that is private to the merchant. 150 characters max. - * @deprecated Instead use getMerchantMemo - * - * @return string - */ - public function getMerchant_memo() - { - return $this->merchant_memo; - } - - /** - * Full URL of an external image to use as the logo. 4000 characters max. - * - * @param string $logo_url - * @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. 4000 characters max. - * - * @return string - */ - public function getLogoUrl() - { - return $this->logo_url; - } - - /** - * Full URL of an external image to use as the logo. 4000 characters max. - * - * @deprecated Instead use setLogoUrl - * - * @param string $logo_url - * @return $this - */ - public function setLogo_url($logo_url) - { - $this->logo_url = $logo_url; - return $this; - } - - /** - * Full URL of an external image to use as the logo. 4000 characters max. - * @deprecated Instead use getLogoUrl - * - * @return string - */ - public function getLogo_url() - { - 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; - } - - /** - * The total amount of the invoice. - * - * @deprecated Instead use setTotalAmount - * - * @param \PayPal\Api\Currency $total_amount - * @return $this - */ - public function setTotal_amount($total_amount) - { - $this->total_amount = $total_amount; - return $this; - } - - /** - * The total amount of the invoice. - * @deprecated Instead use getTotalAmount - * - * @return \PayPal\Api\Currency - */ - public function getTotal_amount() - { - return $this->total_amount; - } - - /** - * List of payment details for the invoice. - * - * @param \PayPal\Api\PaymentDetail[] $payment_details - * - * @return $this - */ - public function setPaymentDetails($payment_details) - { - $this->payment_details = $payment_details; - return $this; - } - - /** - * List of payment details for the invoice. - * - * @return \PayPal\Api\PaymentDetail[] - */ - public function getPaymentDetails() - { - return $this->payment_details; - } - - /** - * Append PaymentDetails to the list. - * - * @param \PayPal\Api\PaymentDetail $paymentDetail - * @return $this - */ - public function addPaymentDetail($paymentDetail) - { - if (!$this->getPaymentDetails()) { - return $this->setPaymentDetails(array($paymentDetail)); - } else { - return $this->setPaymentDetails( - array_merge($this->getPaymentDetails(), array($paymentDetail)) - ); - } - } - - /** - * Remove PaymentDetails from the list. - * - * @param \PayPal\Api\PaymentDetail $paymentDetail - * @return $this - */ - public function removePaymentDetail($paymentDetail) - { - return $this->setPaymentDetails( - array_diff($this->getPaymentDetails(), array($paymentDetail)) - ); - } - - /** - * List of payment details for the invoice. - * - * @deprecated Instead use setPaymentDetails - * - * @param \PayPal\Api\PaymentDetail $payment_details - * @return $this - */ - public function setPayment_details($payment_details) - { - $this->payment_details = $payment_details; - return $this; - } - - /** - * List of payment details for the invoice. - * @deprecated Instead use getPaymentDetails - * - * @return \PayPal\Api\PaymentDetail - */ - public function getPayment_details() - { - return $this->payment_details; - } - - /** - * List of refund details for the invoice. - * - * @param \PayPal\Api\RefundDetail[] $refund_details - * - * @return $this - */ - public function setRefundDetails($refund_details) - { - $this->refund_details = $refund_details; - return $this; - } - - /** - * List of refund details for the invoice. - * - * @return \PayPal\Api\RefundDetail[] - */ - public function getRefundDetails() - { - return $this->refund_details; - } - - /** - * Append RefundDetails to the list. - * - * @param \PayPal\Api\RefundDetail $refundDetail - * @return $this - */ - public function addRefundDetail($refundDetail) - { - if (!$this->getRefundDetails()) { - return $this->setRefundDetails(array($refundDetail)); - } else { - return $this->setRefundDetails( - array_merge($this->getRefundDetails(), array($refundDetail)) - ); - } - } - - /** - * Remove RefundDetails from the list. - * - * @param \PayPal\Api\RefundDetail $refundDetail - * @return $this - */ - public function removeRefundDetail($refundDetail) - { - return $this->setRefundDetails( - array_diff($this->getRefundDetails(), array($refundDetail)) - ); - } - - /** - * List of refund details for the invoice. - * - * @deprecated Instead use setRefundDetails - * - * @param \PayPal\Api\RefundDetail $refund_details - * @return $this - */ - public function setRefund_details($refund_details) - { - $this->refund_details = $refund_details; - return $this; - } - - /** - * List of refund details for the invoice. - * @deprecated Instead use getRefundDetails - * - * @return \PayPal\Api\RefundDetail - */ - public function getRefund_details() - { - return $this->refund_details; - } - - /** - * Audit information for the invoice. - * - * @param \PayPal\Api\Metadata $metadata - * - * @return $this - */ - public function setMetadata($metadata) - { - $this->metadata = $metadata; - return $this; - } - - /** - * Audit information for the invoice. - * - * @return \PayPal\Api\Metadata - */ - public function getMetadata() - { - return $this->metadata; - } - - /** - * Any miscellaneous invoice data. 4000 characters max. - * - * @param string $additional_data - * - * @return $this - */ - public function setAdditionalData($additional_data) - { - $this->additional_data = $additional_data; - return $this; - } - - /** - * Any miscellaneous invoice data. 4000 characters max. - * - * @return string - */ - public function getAdditionalData() - { - return $this->additional_data; - } - - /** - * Any miscellaneous invoice data. 4000 characters max. - * - * @deprecated Instead use setAdditionalData - * - * @param string $additional_data - * @return $this - */ - public function setAdditional_data($additional_data) - { - $this->additional_data = $additional_data; - return $this; - } - - /** - * Any miscellaneous invoice data. 4000 characters max. - * @deprecated Instead use getAdditionalData - * - * @return string - */ - public function getAdditional_data() - { - return $this->additional_data; - } - -} diff --git a/lib/PayPal/Common/FormatConverter.php b/lib/PayPal/Common/FormatConverter.php index bc35ee6..d52612c 100644 --- a/lib/PayPal/Common/FormatConverter.php +++ b/lib/PayPal/Common/FormatConverter.php @@ -4,8 +4,6 @@ namespace PayPal\Common; class FormatConverter { - const TWO_DECIMAL_PLACES = '%0.2f'; - /** * Format the data based on the input formatter value * @@ -27,7 +25,7 @@ class FormatConverter { public static function formatToTwoDecimalPlaces($value) { if (trim($value) != null) { - return static::format($value, self::TWO_DECIMAL_PLACES); + return number_format($value, 2, '.', ''); } return null; } diff --git a/sample/index.html b/sample/index.html index ee98e3a..cce66f4 100644 --- a/sample/index.html +++ b/sample/index.html @@ -187,6 +187,94 @@ + +
+
+

Authorization and capture

+
+ + +
+

-
-
-

Authorization and capture

-
- - -
-

  • -
    Create Invoice
    +
    Create an Invoice
    Execute @@ -577,29 +578,7 @@
  • -
    Get Invoice
    -
    - Execute - Source -
    -
    -
    • -
  • -
    -
    List All Invoice
    -
    - Execute - Source -
    -
    -
    • -
  • -
    -
    Send Invoice
    +
    Send an Invoice
    Execute @@ -610,7 +589,51 @@
  • -
    Remind Invoice
    +
    Update an Invoice
    +
    + Execute + Source +
    +
    +
    • +
  • +
    +
    Retrieve an Invoice
    +
    + Execute + Source +
    +
    +
    • +
  • +
    +
    Get Invoices of a Merchant
    +
    + Execute + Source +
    +
    +
    • +
  • +
    +
    Search for Invoices
    +
    + Execute + Source +
    +
    +
    • +
  • +
    +
    Send an Invoice Reminder
    Execute @@ -621,7 +644,7 @@
  • -
    Cancel Invoice
    +
    Cancel an Invoice
    Execute @@ -630,6 +653,50 @@
    • +
  • +
    +
    Delete an Invoice
    +
    + Execute + Source +
    +
    +
    • +
  • +
    +
    Retrieve a QR Code
    +
    + Execute + Source +
    +
    +
    • +
  • +
    +
    Record a Payment
    +
    + Execute + Source +
    +
    +
    • +
  • +
    +
    Record a Refund
    +
    + Execute + Source +
    +
    +

    • diff --git a/sample/invoice/ListInvoice.php b/sample/invoice/ListInvoice.php index 6108833..0bcb91f 100644 --- a/sample/invoice/ListInvoice.php +++ b/sample/invoice/ListInvoice.php @@ -14,7 +14,7 @@ try { // static `get_all` method on the Invoice class. // Refer the method doc for valid values for keys // (See bootstrap.php for more on `ApiContext`) - $invoices = Invoice::get_all($apiContext); + $invoices = Invoice::getAll(array('page' => 0, 'page_size' => 4, 'total_count_required' => true), $apiContext); } catch (Exception $ex) { ResultPrinter::printError("Lookup Invoice History", "Invoice", null, null, $ex); exit(1); diff --git a/sample/invoice/RemindInvoice.php b/sample/invoice/RemindInvoice.php index f972b39..9904eee 100644 --- a/sample/invoice/RemindInvoice.php +++ b/sample/invoice/RemindInvoice.php @@ -11,13 +11,6 @@ use PayPal\Api\Invoice; use PayPal\Api\Notification; try { - // ### Retrieve Invoice - // Retrieve the invoice object by calling the - // static `get` method - // on the Invoice class by passing a valid - // Invoice ID - // (See bootstrap.php for more on `ApiContext`) - $invoice = Invoice::get($invoice->getId(), $apiContext); // ### Notification Object // This would send a notification to both merchant as well diff --git a/sample/invoice/RetrieveQRCode.php b/sample/invoice/RetrieveQRCode.php new file mode 100644 index 0000000..ee82eb2 --- /dev/null +++ b/sample/invoice/RetrieveQRCode.php @@ -0,0 +1,41 @@ +getId(), array('height' => '300', 'width' => '300'), $apiContext); + + // ### Optionally Save to File + // This is not a required step. However, if you want to store this image as a file, you can use + // 'saveToFile' method with proper file name. + // This will save the image as /samples/invoice/images/sample.png + $path = $image->saveToFile("images/sample.png"); + + +} catch (Exception $ex) { + ResultPrinter::printError("Retrieved QR Code for Invoice", "Invoice", $invoice->getId(), null, $ex); + exit(1); +} + +ResultPrinter::printResult("Retrieved QR Code for Invoice", "Invoice", $invoice->getId(), null, $image); + +// ### Show the Image +// In PHP, there are many ways to present an images. +// One of the ways, you could directly inject the base64-encoded string +// with proper image information in front of it. +echo 'Invoice QR Code'; + diff --git a/sample/invoice/SendInvoice.php b/sample/invoice/SendInvoice.php index f19eba7..9c3493d 100644 --- a/sample/invoice/SendInvoice.php +++ b/sample/invoice/SendInvoice.php @@ -10,13 +10,6 @@ $invoice = require 'CreateInvoice.php'; use PayPal\Api\Invoice; try { - // ### Retrieve Invoice - // Retrieve the invoice object by calling the - // static `get` method - // on the Invoice class by passing a valid - // Invoice ID - // (See bootstrap.php for more on `ApiContext`) - $invoice = Invoice::get($invoice->getId(), $apiContext); // ### Send Invoice // Send a legitimate invoice to the payer diff --git a/sample/invoice/UpdateInvoice.php b/sample/invoice/UpdateInvoice.php new file mode 100644 index 0000000..2076b07 --- /dev/null +++ b/sample/invoice/UpdateInvoice.php @@ -0,0 +1,31 @@ +setInvoiceDate("2014-11-16 PST"); + + +// For Sample Purposes Only. +$request = clone $invoice; + +try { + // ### Update Invoice + // Update an invoice by calling the invoice->update() method + // with a valid ApiContext (See bootstrap.php for more on `ApiContext`) + $invoice->update($apiContext); +} catch (Exception $ex) { + ResultPrinter::printError("Invoice Updated", "Invoice", null, $request, $ex); + exit(1); +} + +ResultPrinter::printResult("Invoice Updated", "Invoice", $invoice->getId(), $request, $invoice); + +return $invoice; diff --git a/tests/PayPal/Test/Common/FormatConverterTest.php b/tests/PayPal/Test/Common/FormatConverterTest.php index 1970b2c..b425dbc 100644 --- a/tests/PayPal/Test/Common/FormatConverterTest.php +++ b/tests/PayPal/Test/Common/FormatConverterTest.php @@ -62,6 +62,12 @@ class FormatConverterTest extends \PHPUnit_Framework_TestCase } + public function testFormat() + { + $result = FormatConverter::format("12.0123", "%0.2f"); + $this->assertEquals("12.01", $result); + } + /** * @dataProvider apiModelSettersProvider *