Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mcoil.corals.io/vendor/paypal/rest-api-sdk-php/lib/PayPal/Api/ |
<?php
namespace PayPal\Api;
use PayPal\Common\PayPalResourceModel;
use PayPal\Rest\ApiContext;
use PayPal\Transport\PayPalRestCall;
use PayPal\Validation\ArgumentValidator;
use PayPal\Validation\UrlValidator;
/**
* Class Invoice
*
* Detailed invoice information.
*
* @package PayPal\Api
*
* @property string id
* @property string number
* @property string uri
* @property string status
* @property \PayPal\Api\MerchantInfo merchant_info
* @property \PayPal\Api\BillingInfo[] billing_info
* @property \PayPal\Api\ShippingInfo shipping_info
* @property \PayPal\Api\InvoiceItem[] items
* @property string invoice_date
* @property \PayPal\Api\PaymentTerm payment_term
* @property \PayPal\Api\Cost discount
* @property \PayPal\Api\ShippingCost shipping_cost
* @property \PayPal\Api\CustomAmount custom
* @property bool tax_calculated_after_discount
* @property bool tax_inclusive
* @property string terms
* @property string note
* @property string merchant_memo
* @property string logo_url
* @property \PayPal\Api\Currency total_amount
* @property \PayPal\Api\PaymentDetail[] payments
* @property \PayPal\Api\RefundDetail[] refunds
* @property \PayPal\Api\Metadata metadata
* @property string additional_data
*/
class Invoice extends PayPalResourceModel
{
/**
* Unique invoice resource identifier.
*
* @param string $id
*
* @return $this
*/
public function setId($id)
{
$this->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;
}
/**
* 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))
);
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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 payment details for the invoice.
*
* @param \PayPal\Api\PaymentDetail[] $payments
*
* @return $this
*/
public function setPayments($payments)
{
$this->payments = $payments;
return $this;
}
/**
* List of payment details for the invoice.
*
* @return \PayPal\Api\PaymentDetail[]
*/
public function getPayments()
{
return $this->payments;
}
/**
* Append PaymentDetails to the list.
*
* @param \PayPal\Api\PaymentDetail $paymentDetail
* @return $this
*/
public function addPaymentDetail($paymentDetail)
{
if (!$this->getPayments()) {
return $this->setPayments(array($paymentDetail));
} else {
return $this->setPayments(
array_merge($this->getPayments(), array($paymentDetail))
);
}
}
/**
* Remove PaymentDetails from the list.
*
* @param \PayPal\Api\PaymentDetail $paymentDetail
* @return $this
*/
public function removePaymentDetail($paymentDetail)
{
return $this->setPayments(
array_diff($this->getPayments(), array($paymentDetail))
);
}
/**
* List of refund details for the invoice.
*
* @param \PayPal\Api\RefundDetail[] $refunds
*
* @return $this
*/
public function setRefunds($refunds)
{
$this->refunds = $refunds;
return $this;
}
/**
* List of refund details for the invoice.
*
* @return \PayPal\Api\RefundDetail[]
*/
public function getRefunds()
{
return $this->refunds;
}
/**
* Append RefundDetails to the list.
*
* @param \PayPal\Api\RefundDetail $refundDetail
* @return $this
*/
public function addRefundDetail($refundDetail)
{
if (!$this->getRefunds()) {
return $this->setRefunds(array($refundDetail));
} else {
return $this->setRefunds(
array_merge($this->getRefunds(), array($refundDetail))
);
}
}
/**
* Remove RefundDetails from the list.
*
* @param \PayPal\Api\RefundDetail $refundDetail
* @return $this
*/
public function removeRefundDetail($refundDetail)
{
return $this->setRefunds(
array_diff($this->getRefunds(), array($refundDetail))
);
}
/**
* 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;
}
/**
* Create a new invoice by passing the details for the invoice, including the merchant_info, to the request URI.
*
* @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 Invoice
*/
public function create($apiContext = null, $restCall = null)
{
$payLoad = $this->toJSON();
$json = self::executeCall(
"/v1/invoicing/invoices",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
$this->fromJson($json);
return $this;
}
/**
* Search for a specific invoice or invoices by passing a search object that specifies your search criteria to the request URI.
*
* @param Search $search
* @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 InvoiceSearchResponse
*/
public static function search($search, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($search, 'search');
$payLoad = $search->toJSON();
$json = self::executeCall(
"/v1/invoicing/search",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
$ret = new InvoiceSearchResponse();
$ret->fromJson($json);
return $ret;
}
/**
* 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.
*
* @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 bool
*/
public function send($apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
$payLoad = "";
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}/send",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* 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.
*
* @param Notification $notification
* @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 bool
*/
public function remind($notification, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
ArgumentValidator::validate($notification, 'notification');
$payLoad = $notification->toJSON();
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}/remind",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* Cancel an invoice by passing the invoice ID to the request URI.
*
* @param CancelNotification $cancelNotification
* @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 bool
*/
public function cancel($cancelNotification, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
ArgumentValidator::validate($cancelNotification, 'cancelNotification');
$payLoad = $cancelNotification->toJSON();
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}/cancel",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* 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.
*
* @param PaymentDetail $paymentDetail
* @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 bool
*/
public function recordPayment($paymentDetail, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
ArgumentValidator::validate($paymentDetail, 'paymentDetail');
$payLoad = $paymentDetail->toJSON();
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}/record-payment",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* 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.
*
* @param RefundDetail $refundDetail
* @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 bool
*/
public function recordRefund($refundDetail, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
ArgumentValidator::validate($refundDetail, 'refundDetail');
$payLoad = $refundDetail->toJSON();
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}/record-refund",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* Retrieve the details for a particular invoice by passing the invoice ID to the request URI.
*
* @param string $invoiceId
* @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 Invoice
*/
public static function get($invoiceId, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($invoiceId, 'invoiceId');
$payLoad = "";
$json = self::executeCall(
"/v1/invoicing/invoices/$invoiceId",
"GET",
$payLoad,
null,
$apiContext,
$restCall
);
$ret = new Invoice();
$ret->fromJson($json);
return $ret;
}
/**
* 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 PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return InvoiceSearchResponse
*/
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/?" . http_build_query(array_intersect_key($params, $allowedParams)),
"GET",
$payLoad,
null,
$apiContext,
$restCall
);
$ret = new InvoiceSearchResponse();
$ret->fromJson($json);
return $ret;
}
/**
* 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.
*
* @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 Invoice
*/
public function update($apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
$payLoad = $this->toJSON();
$json = self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}",
"PUT",
$payLoad,
null,
$apiContext,
$restCall
);
$this->fromJson($json);
return $this;
}
/**
* Delete a particular invoice by passing the invoice ID to the request URI.
*
* @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 bool
*/
public function delete($apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
$payLoad = "";
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}",
"DELETE",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* 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 PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return Image
*/
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?" . http_build_query(array_intersect_key($params, $allowedParams)),
"GET",
$payLoad,
null,
$apiContext,
$restCall
);
$ret = new Image();
$ret->fromJson($json);
return $ret;
}
}