<?php
namespace Srmklive\PayPal\Traits\PayPalAPI\InvoiceSearch;
use Carbon\Carbon;
trait Filters
{
/**
* @var array
*/
protected $invoice_search_filters = [];
/**
* @var array
*/
protected $invoices_date_types = [
'invoice_date',
'due_date',
'payment_date',
'creation_date',
];
/**
* @var array
*/
protected $invoices_status_types = [
'DRAFT',
'SENT',
'SCHEDULED',
'PAID',
'MARKED_AS_PAID',
'CANCELLED',
'REFUNDED',
'PARTIALLY_PAID',
'PARTIALLY_REFUNDED',
'MARKED_AS_REFUNDED',
'UNPAID',
'PAYMENT_PENDING',
];
/**
* @param string $email
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByRecipientEmail(string $email): \Srmklive\PayPal\Services\PayPal
{
$this->invoice_search_filters['recipient_email'] = $email;
return $this;
}
/**
* @param string $name
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByRecipientFirstName(string $name): \Srmklive\PayPal\Services\PayPal
{
$this->invoice_search_filters['recipient_first_name'] = $name;
return $this;
}
/**
* @param string $name
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByRecipientLastName(string $name): \Srmklive\PayPal\Services\PayPal
{
$this->invoice_search_filters['recipient_last_name'] = $name;
return $this;
}
/**
* @param string $name
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByRecipientBusinessName(string $name): \Srmklive\PayPal\Services\PayPal
{
$this->invoice_search_filters['recipient_business_name'] = $name;
return $this;
}
/**
* @param string $invoice_number
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByInvoiceNumber(string $invoice_number): \Srmklive\PayPal\Services\PayPal
{
$this->invoice_search_filters['invoice_number'] = $invoice_number;
return $this;
}
/**
* @param array $status
*
* @throws \Exception
*
* @return \Srmklive\PayPal\Services\PayPal
*
* @see https://developer.paypal.com/docs/api/invoicing/v2/#definition-invoice_status
*/
public function addInvoiceFilterByInvoiceStatus(array $status): \Srmklive\PayPal\Services\PayPal
{
$invalid_status = false;
foreach ($status as $item) {
if (!in_array($item, $this->invoices_status_types)) {
$invalid_status = true;
}
}
if ($invalid_status === true) {
throw new \Exception('status should be always one of these: '.implode(',', $this->invoices_date_types));
}
$this->invoice_search_filters['status'] = $status;
return $this;
}
/**
* @param string $reference
* @param bool $memo
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByReferenceorMemo(string $reference, bool $memo = false): \Srmklive\PayPal\Services\PayPal
{
$field = ($memo === false) ? 'reference' : 'memo';
$this->invoice_search_filters[$field] = $reference;
return $this;
}
/**
* @param string $currency_code
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByCurrencyCode(string $currency_code = ''): \Srmklive\PayPal\Services\PayPal
{
$currency = !isset($currency_code) ? $this->getCurrency() : $currency_code;
$this->invoice_search_filters['currency_code'] = $currency;
return $this;
}
/**
* @param float $start_amount
* @param float $end_amount
* @param string $amount_currency
*
* @throws \Exception
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByAmountRange(float $start_amount, float $end_amount, string $amount_currency = ''): \Srmklive\PayPal\Services\PayPal
{
if ($start_amount > $end_amount) {
throw new \Exception('Starting amount should always be less than end amount!');
}
$currency = !isset($amount_currency) ? $this->getCurrency() : $amount_currency;
$this->invoice_search_filters['total_amount_range'] = [
'lower_amount' => [
'currency_code' => $currency,
'value' => $start_amount,
],
'upper_amount' => [
'currency_code' => $currency,
'value' => $end_amount,
],
];
return $this;
}
/**
* @param string $start_date
* @param string $end_date
* @param string $date_type
*
* @throws \Exception
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByDateRange(string $start_date, string $end_date, string $date_type): \Srmklive\PayPal\Services\PayPal
{
$start_date_obj = Carbon::parse($start_date);
$end_date_obj = Carbon::parse($end_date);
if ($start_date_obj->gt($end_date_obj)) {
throw new \Exception('Starting date should always be less than the end date!');
}
if (!in_array($date_type, $this->invoices_date_types)) {
throw new \Exception('date type should be always one of these: '.implode(',', $this->invoices_date_types));
}
$this->invoice_search_filters["{$date_type}_range"] = [
'start' => $start_date,
'end' => $end_date,
];
return $this;
}
/**
* @param bool $archived
*
* @return \Srmklive\PayPal\Services\PayPal
*/
public function addInvoiceFilterByArchivedStatus(bool $archived = null): \Srmklive\PayPal\Services\PayPal
{
$this->invoice_search_filters['archived'] = $archived;
return $this;
}
/**
* @param array $fields
*
* @return \Srmklive\PayPal\Services\PayPal
*
* @see https://developer.paypal.com/docs/api/invoicing/v2/#definition-field
*/
public function addInvoiceFilterByFields(array $fields): \Srmklive\PayPal\Services\PayPal
{
$this->invoice_search_filters['status'] = $fields;
return $this;
}
}
Payment Accept
Our platform simplifies payment acceptance, making transaction management effortless. With secure processing and user-friendly tools, you can easily handle payments from credit cards, debit cards, and digital methods. Our intuitive interface is designed for efficiency, ensuring a seamless experience for both you and your customers. Manage your transactions with ease and confidence.
