lxbfYeaa/PayPal-PHP-SDK
Archived
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-SDK
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

First Update on Invoicing APIs

Browse Source
This commit is contained in:
japatel
2014-11-18 12:12:35 -06:00
parent f0ccc950ad
commit e6fb968509
25 changed files with 2729 additions and 552 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
lib/PayPal/Api/BillingInfo.php
View File

@@ -1,15 +1,34 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class BillingInfo
*
* Billing information for the invoice recipient.
*
* @package PayPal\Api
*
* @property string email
* @property string first_name
* @property string last_name
* @property string business_name
* @property \PayPal\Api\Address address
* @property string language
* @property string additional_info
* @property string notification_channel
* @property \PayPal\Api\Phone phone
*/
class BillingInfo extends PPModel
{
/**
* Email address of the invoice recipient. 260 characters max.
*
* @param string $email
*
* @return $this
*/
public function setEmail($email)
{
@@ -27,11 +46,12 @@ class BillingInfo extends PPModel
return $this->email;
}
/**
* First name of the invoice recipient. 30 characters max.
*
* @param string $first_name
*
* @return $this
*/
public function setFirstName($first_name)
{
@@ -52,8 +72,10 @@ class BillingInfo extends PPModel
/**
* First name of the invoice recipient. 30 characters max.
*
* @deprecated Instead use setFirstName
*
* @param string $first_name
* @deprecated. Instead use setFirstName
* @return $this
*/
public function setFirst_name($first_name)
{
@@ -63,9 +85,9 @@ class BillingInfo extends PPModel
/**
* First name of the invoice recipient. 30 characters max.
* @deprecated Instead use getFirstName
*
* @return string
* @deprecated. Instead use getFirstName
*/
public function getFirst_name()
{
@@ -76,6 +98,8 @@ class BillingInfo extends PPModel
* Last name of the invoice recipient. 30 characters max.
*
* @param string $last_name
*
* @return $this
*/
public function setLastName($last_name)
{
@@ -96,8 +120,10 @@ class BillingInfo extends PPModel
/**
* Last name of the invoice recipient. 30 characters max.
*
* @deprecated Instead use setLastName
*
* @param string $last_name
* @deprecated. Instead use setLastName
* @return $this
*/
public function setLast_name($last_name)
{
@@ -107,9 +133,9 @@ class BillingInfo extends PPModel
/**
* Last name of the invoice recipient. 30 characters max.
* @deprecated Instead use getLastName
*
* @return string
* @deprecated. Instead use getLastName
*/
public function getLast_name()
{
@@ -120,6 +146,8 @@ class BillingInfo extends PPModel
* Company business name of the invoice recipient. 100 characters max.
*
* @param string $business_name
*
* @return $this
*/
public function setBusinessName($business_name)
{
@@ -140,8 +168,10 @@ class BillingInfo extends PPModel
/**
* Company business name of the invoice recipient. 100 characters max.
*
* @deprecated Instead use setBusinessName
*
* @param string $business_name
* @deprecated. Instead use setBusinessName
* @return $this
*/
public function setBusiness_name($business_name)
{
@@ -151,9 +181,9 @@ class BillingInfo extends PPModel
/**
* Company business name of the invoice recipient. 100 characters max.
* @deprecated Instead use getBusinessName
*
* @return string
* @deprecated. Instead use getBusinessName
*/
public function getBusiness_name()
{
@@ -163,7 +193,9 @@ class BillingInfo extends PPModel
/**
* Address of the invoice recipient.
*
* @param PayPal\Api\Address $address
* @param \PayPal\Api\Address $address
*
* @return $this
*/
public function setAddress($address)
{
@@ -174,18 +206,20 @@ class BillingInfo extends PPModel
/**
* Address of the invoice recipient.
*
* @return PayPal\Api\Address
* @return \PayPal\Api\Address
*/
public function getAddress()
{
return $this->address;
}
/**
* Language of the email sent to the payer. Will only be used if payer doesn't have a PayPal account.
* 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"]
*
* @param string $language
*
* @return $this
*/
public function setLanguage($language)
{
@@ -203,11 +237,12 @@ class BillingInfo extends PPModel
return $this->language;
}
/**
* Option to display additional information such as business hours. 40 characters max.
*
* @param string $additional_info
*
* @return $this
*/
public function setAdditionalInfo($additional_info)
{
@@ -228,8 +263,10 @@ class BillingInfo extends PPModel
/**
* Option to display additional information such as business hours. 40 characters max.
*
* @deprecated Instead use setAdditionalInfo
*
* @param string $additional_info
* @deprecated. Instead use setAdditionalInfo
* @return $this
*/
public function setAdditional_info($additional_info)
{
@@ -239,13 +276,85 @@ class BillingInfo extends PPModel
/**
* Option to display additional information such as business hours. 40 characters max.
* @deprecated Instead use getAdditionalInfo
*
* @return string
* @deprecated. Instead use getAdditionalInfo
*/
public function getAdditional_info()
{
return $this->additional_info;
}
/**
* Preferred notification channel of the payer. Email by default.
* Valid Values: ["SMS", "EMAIL"]
*
* @param string $notification_channel
*
* @return $this
*/
public function setNotificationChannel($notification_channel)
{
$this->notification_channel = $notification_channel;
return $this;
}
/**
* Preferred notification channel of the payer. Email by default.
*
* @return string
*/
public function getNotificationChannel()
{
return $this->notification_channel;
}
/**
* Preferred notification channel of the payer. Email by default.
*
* @deprecated Instead use setNotificationChannel
*
* @param string $notification_channel
* @return $this
*/
public function setNotification_channel($notification_channel)
{
$this->notification_channel = $notification_channel;
return $this;
}
/**
* Preferred notification channel of the payer. Email by default.
* @deprecated Instead use getNotificationChannel
*
* @return string
*/
public function getNotification_channel()
{
return $this->notification_channel;
}
/**
* Mobile Phone number of the recipient to which SMS will be sent if notification_channel is SMS.
*
* @param \PayPal\Api\Phone $phone
*
* @return $this
*/
public function setPhone($phone)
{
$this->phone = $phone;
return $this;
}
/**
* Mobile Phone number of the recipient to which SMS will be sent if notification_channel is SMS.
*
* @return \PayPal\Api\Phone
*/
public function getPhone()
{
return $this->phone;
}
}

52
lib/PayPal/Api/CancelNotification.php
View File

@@ -1,15 +1,29 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class CancelNotification
*
* Email/SMS notification.
*
* @package PayPal\Api
*
* @property string subject
* @property string note
* @property bool send_to_merchant
* @property bool send_to_payer
*/
class CancelNotification extends PPModel
{
/**
* Subject of the notification.
*
* @param string $subject
*
* @return $this
*/
public function setSubject($subject)
{
@@ -27,11 +41,12 @@ class CancelNotification extends PPModel
return $this->subject;
}
/**
* Note to the payer.
*
* @param string $note
*
* @return $this
*/
public function setNote($note)
{
@@ -49,11 +64,12 @@ class CancelNotification extends PPModel
return $this->note;
}
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @param boolean $send_to_merchant
* @param bool $send_to_merchant
*
* @return $this
*/
public function setSendToMerchant($send_to_merchant)
{
@@ -64,7 +80,7 @@ class CancelNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @return boolean
* @return bool
*/
public function getSendToMerchant()
{
@@ -74,8 +90,10 @@ class CancelNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @param boolean $send_to_merchant
* @deprecated. Instead use setSendToMerchant
* @deprecated Instead use setSendToMerchant
*
* @param bool $send_to_merchant
* @return $this
*/
public function setSend_to_merchant($send_to_merchant)
{
@@ -85,9 +103,9 @@ class CancelNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
* @deprecated Instead use getSendToMerchant
*
* @return boolean
* @deprecated. Instead use getSendToMerchant
* @return bool
*/
public function getSend_to_merchant()
{
@@ -97,7 +115,9 @@ class CancelNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the payer.
*
* @param boolean $send_to_payer
* @param bool $send_to_payer
*
* @return $this
*/
public function setSendToPayer($send_to_payer)
{
@@ -108,7 +128,7 @@ class CancelNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the payer.
*
* @return boolean
* @return bool
*/
public function getSendToPayer()
{
@@ -118,8 +138,10 @@ class CancelNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the payer.
*
* @param boolean $send_to_payer
* @deprecated. Instead use setSendToPayer
* @deprecated Instead use setSendToPayer
*
* @param bool $send_to_payer
* @return $this
*/
public function setSend_to_payer($send_to_payer)
{
@@ -129,9 +151,9 @@ class CancelNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the payer.
* @deprecated Instead use getSendToPayer
*
* @return boolean
* @deprecated. Instead use getSendToPayer
* @return bool
*/
public function getSend_to_payer()
{

26
lib/PayPal/Api/Cost.php
View File

@@ -1,15 +1,27 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* 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.
*
* @package PayPal\Api
*
* @property \PayPal\Api\number percent
* @property \PayPal\Api\Currency amount
*/
class Cost extends PPModel
{
/**
* Cost in percent. Range of 0 to 100.
*
* @param PayPal\Api\number $percent
* @param \PayPal\Api\number $percent
*
* @return $this
*/
public function setPercent($percent)
{
@@ -20,18 +32,19 @@ class Cost extends PPModel
/**
* Cost in percent. Range of 0 to 100.
*
* @return PayPal\Api\number
* @return \PayPal\Api\number
*/
public function getPercent()
{
return $this->percent;
}
/**
* Cost in amount. Range of 0 to 999999.99.
*
* @param PayPal\Api\Currency $amount
* @param \PayPal\Api\Currency $amount
*
* @return $this
*/
public function setAmount($amount)
{
@@ -42,12 +55,11 @@ class Cost extends PPModel
/**
* Cost in amount. Range of 0 to 999999.99.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getAmount()
{
return $this->amount;
}
}

22
lib/PayPal/Api/CustomAmount.php
View File

@@ -1,15 +1,27 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class CustomAmount
*
* Custom amount applied on an invoice. If a label is included then the amount cannot be empty.
*
* @package PayPal\Api
*
* @property string label
* @property \PayPal\Api\Currency amount
*/
class CustomAmount extends PPModel
{
/**
* Custom amount label. 25 characters max.
*
* @param string $label
*
* @return $this
*/
public function setLabel($label)
{
@@ -27,11 +39,12 @@ class CustomAmount extends PPModel
return $this->label;
}
/**
* Custom amount value. Range of 0 to 999999.99.
*
* @param PayPal\Api\Currency $amount
* @param \PayPal\Api\Currency $amount
*
* @return $this
*/
public function setAmount($amount)
{
@@ -42,12 +55,11 @@ class CustomAmount extends PPModel
/**
* Custom amount value. Range of 0 to 999999.99.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getAmount()
{
return $this->amount;
}
}

126
lib/PayPal/Api/Error.php
View File

@@ -1,15 +1,31 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class Error
*
* Details of an Error
*
* @package PayPal\Api
*
* @property string name
* @property string debug_id
* @property string message
* @property string information_link
* @property \PayPal\Api\ErrorDetails[] details
* @property \PayPal\Api\Links[] links
*/
class Error extends PPModel
{
/**
* Human readable, unique name of the error.
*
* @param string $name
*
* @return $this
*/
public function setName($name)
{
@@ -27,11 +43,12 @@ class Error extends PPModel
return $this->name;
}
/**
* PayPal internal identifier used for correlation purposes.
*
* @param string $debug_id
*
* @return $this
*/
public function setDebugId($debug_id)
{
@@ -52,8 +69,10 @@ class Error extends PPModel
/**
* PayPal internal identifier used for correlation purposes.
*
* @deprecated Instead use setDebugId
*
* @param string $debug_id
* @deprecated. Instead use setDebugId
* @return $this
*/
public function setDebug_id($debug_id)
{
@@ -63,9 +82,9 @@ class Error extends PPModel
/**
* PayPal internal identifier used for correlation purposes.
* @deprecated Instead use getDebugId
*
* @return string
* @deprecated. Instead use getDebugId
*/
public function getDebug_id()
{
@@ -76,6 +95,8 @@ class Error extends PPModel
* Message describing the error.
*
* @param string $message
*
* @return $this
*/
public function setMessage($message)
{
@@ -93,11 +114,12 @@ class Error extends PPModel
return $this->message;
}
/**
* URI for detailed information related to this error for the developer.
*
* @param string $information_link
*
* @return $this
*/
public function setInformationLink($information_link)
{
@@ -118,8 +140,10 @@ class Error extends PPModel
/**
* URI for detailed information related to this error for the developer.
*
* @deprecated Instead use setInformationLink
*
* @param string $information_link
* @deprecated. Instead use setInformationLink
* @return $this
*/
public function setInformation_link($information_link)
{
@@ -129,9 +153,9 @@ class Error extends PPModel
/**
* URI for detailed information related to this error for the developer.
* @deprecated Instead use getInformationLink
*
* @return string
* @deprecated. Instead use getInformationLink
*/
public function getInformation_link()
{
@@ -141,7 +165,9 @@ class Error extends PPModel
/**
* Additional details of the error
*
* @param PayPal\Api\ErrorDetails $details
* @param \PayPal\Api\ErrorDetails[] $details
*
* @return $this
*/
public function setDetails($details)
{
@@ -152,12 +178,94 @@ class Error extends PPModel
/**
* Additional details of the error
*
* @return PayPal\Api\ErrorDetails
* @return \PayPal\Api\ErrorDetails[]
*/
public function getDetails()
{
return $this->details;
}
/**
* Append Details to the list.
*
* @param \PayPal\Api\ErrorDetails $errorDetails
* @return $this
*/
public function addDetail($errorDetails)
{
if (!$this->getDetails()) {
return $this->setDetails(array($errorDetails));
} else {
return $this->setDetails(
array_merge($this->getDetails(), array($errorDetails))
);
}
}
/**
* Remove Details from the list.
*
* @param \PayPal\Api\ErrorDetails $errorDetails
* @return $this
*/
public function removeDetail($errorDetails)
{
return $this->setDetails(
array_diff($this->getDetails(), array($errorDetails))
);
}
/**
* Sets Links
*
* @param \PayPal\Api\Links[] $links
*
* @return $this
*/
public function setLinks($links)
{
$this->links = $links;
return $this;
}
/**
* Gets Links
*
* @return \PayPal\Api\Links[]
*/
public function getLinks()
{
return $this->links;
}
/**
* Append Links to the list.
*
* @param \PayPal\Api\Links $links
* @return $this
*/
public function addLink($links)
{
if (!$this->getLinks()) {
return $this->setLinks(array($links));
} else {
return $this->setLinks(
array_merge($this->getLinks(), array($links))
);
}
}
/**
* Remove Links from the list.
*
* @param \PayPal\Api\Links $links
* @return $this
*/
public function removeLink($links)
{
return $this->setLinks(
array_diff($this->getLinks(), array($links))
);
}
}

18
lib/PayPal/Api/ErrorDetails.php
View File

@@ -1,15 +1,27 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class ErrorDetails
*
* Details about a specific error.
*
* @package PayPal\Api
*
* @property string field
* @property string issue
*/
class ErrorDetails extends PPModel
{
/**
* Name of the field that caused the error.
*
* @param string $field
*
* @return $this
*/
public function setField($field)
{
@@ -27,11 +39,12 @@ class ErrorDetails extends PPModel
return $this->field;
}
/**
* Reason for the error.
*
* @param string $issue
*
* @return $this
*/
public function setIssue($issue)
{
@@ -49,5 +62,4 @@ class ErrorDetails extends PPModel
return $this->issue;
}
}

486
lib/PayPal/Api/Invoice.php
View File

File diff suppressed because it is too large Load Diff

67
lib/PayPal/Api/InvoiceItem.php
View File

@@ -1,15 +1,32 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class InvoiceItem
*
* Information about a single line item.
*
* @package PayPal\Api
*
* @property string name
* @property string description
* @property \PayPal\Api\number quantity
* @property \PayPal\Api\Currency unit_price
* @property \PayPal\Api\Tax tax
* @property string date
* @property \PayPal\Api\Cost discount
*/
class InvoiceItem extends PPModel
{
/**
* Name of the item. 60 characters max.
*
* @param string $name
*
* @return $this
*/
public function setName($name)
{
@@ -27,11 +44,12 @@ class InvoiceItem extends PPModel
return $this->name;
}
/**
* Description of the item. 1000 characters max.
*
* @param string $description
*
* @return $this
*/
public function setDescription($description)
{
@@ -49,11 +67,12 @@ class InvoiceItem extends PPModel
return $this->description;
}
/**
* Quantity of the item. Range of 0 to 9999.999.
*
* @param PayPal\Api\number $quantity
* @param \PayPal\Api\number $quantity
*
* @return $this
*/
public function setQuantity($quantity)
{
@@ -64,18 +83,19 @@ class InvoiceItem extends PPModel
/**
* Quantity of the item. Range of 0 to 9999.999.
*
* @return PayPal\Api\number
* @return \PayPal\Api\number
*/
public function getQuantity()
{
return $this->quantity;
}
/**
* Unit price of the item. Range of -999999.99 to 999999.99.
*
* @param PayPal\Api\Currency $unit_price
* @param \PayPal\Api\Currency $unit_price
*
* @return $this
*/
public function setUnitPrice($unit_price)
{
@@ -86,7 +106,7 @@ class InvoiceItem extends PPModel
/**
* Unit price of the item. Range of -999999.99 to 999999.99.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getUnitPrice()
{
@@ -96,8 +116,10 @@ class InvoiceItem extends PPModel
/**
* Unit price of the item. Range of -999999.99 to 999999.99.
*
* @param PayPal\Api\Currency $unit_price
* @deprecated. Instead use setUnitPrice
* @deprecated Instead use setUnitPrice
*
* @param \PayPal\Api\Currency $unit_price
* @return $this
*/
public function setUnit_price($unit_price)
{
@@ -107,9 +129,9 @@ class InvoiceItem extends PPModel
/**
* Unit price of the item. Range of -999999.99 to 999999.99.
* @deprecated Instead use getUnitPrice
*
* @return PayPal\Api\Currency
* @deprecated. Instead use getUnitPrice
* @return \PayPal\Api\Currency
*/
public function getUnit_price()
{
@@ -119,7 +141,9 @@ class InvoiceItem extends PPModel
/**
* Tax associated with the item.
*
* @param PayPal\Api\Tax $tax
* @param \PayPal\Api\Tax $tax
*
* @return $this
*/
public function setTax($tax)
{
@@ -130,18 +154,19 @@ class InvoiceItem extends PPModel
/**
* Tax associated with the item.
*
* @return PayPal\Api\Tax
* @return \PayPal\Api\Tax
*/
public function getTax()
{
return $this->tax;
}
/**
* Date on which the item or service was provided. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
* 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).
*
* @param string $date
*
* @return $this
*/
public function setDate($date)
{
@@ -150,7 +175,7 @@ class InvoiceItem extends PPModel
}
/**
* Date on which the item or service was provided. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
* 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).
*
* @return string
*/
@@ -159,11 +184,12 @@ class InvoiceItem extends PPModel
return $this->date;
}
/**
* Item discount in percent or amount.
*
* @param PayPal\Api\Cost $discount
* @param \PayPal\Api\Cost $discount
*
* @return $this
*/
public function setDiscount($discount)
{
@@ -174,12 +200,11 @@ class InvoiceItem extends PPModel
/**
* Item discount in percent or amount.
*
* @return PayPal\Api\Cost
* @return \PayPal\Api\Cost
*/
public function getDiscount()
{
return $this->discount;
}
}

1045
lib/PayPal/Api/Invoices.php
View File

File diff suppressed because it is too large Load Diff

142
lib/PayPal/Api/InvoicingMetaData.php
View File

@@ -1,15 +1,36 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
use PayPal\Validation\UrlValidator;
/**
* Class InvoicingMetaData
*
* Audit information of the resource.
*
* @package PayPal\Api
*
* @property string created_date
* @property string created_by
* @property string cancelled_date
* @property string cancelled_by
* @property string last_updated_date
* @property string last_updated_by
* @property string first_sent_date
* @property string last_sent_date
* @property string last_sent_by
* @property string payer_view_url
*/
class InvoicingMetaData extends PPModel
{
/**
* Date when the resource was created.
*
* @param string $created_date
*
* @return $this
*/
public function setCreatedDate($created_date)
{
@@ -30,8 +51,10 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was created.
*
* @deprecated Instead use setCreatedDate
*
* @param string $created_date
* @deprecated. Instead use setCreatedDate
* @return $this
*/
public function setCreated_date($created_date)
{
@@ -41,9 +64,9 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was created.
* @deprecated Instead use getCreatedDate
*
* @return string
* @deprecated. Instead use getCreatedDate
*/
public function getCreated_date()
{
@@ -54,6 +77,8 @@ class InvoicingMetaData extends PPModel
* Email address of the account that created the resource.
*
* @param string $created_by
*
* @return $this
*/
public function setCreatedBy($created_by)
{
@@ -74,8 +99,10 @@ class InvoicingMetaData extends PPModel
/**
* Email address of the account that created the resource.
*
* @deprecated Instead use setCreatedBy
*
* @param string $created_by
* @deprecated. Instead use setCreatedBy
* @return $this
*/
public function setCreated_by($created_by)
{
@@ -85,9 +112,9 @@ class InvoicingMetaData extends PPModel
/**
* Email address of the account that created the resource.
* @deprecated Instead use getCreatedBy
*
* @return string
* @deprecated. Instead use getCreatedBy
*/
public function getCreated_by()
{
@@ -98,6 +125,8 @@ class InvoicingMetaData extends PPModel
* Date when the resource was cancelled.
*
* @param string $cancelled_date
*
* @return $this
*/
public function setCancelledDate($cancelled_date)
{
@@ -118,8 +147,10 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was cancelled.
*
* @deprecated Instead use setCancelledDate
*
* @param string $cancelled_date
* @deprecated. Instead use setCancelledDate
* @return $this
*/
public function setCancelled_date($cancelled_date)
{
@@ -129,9 +160,9 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was cancelled.
* @deprecated Instead use getCancelledDate
*
* @return string
* @deprecated. Instead use getCancelledDate
*/
public function getCancelled_date()
{
@@ -142,6 +173,8 @@ class InvoicingMetaData extends PPModel
* Actor who cancelled the resource.
*
* @param string $cancelled_by
*
* @return $this
*/
public function setCancelledBy($cancelled_by)
{
@@ -162,8 +195,10 @@ class InvoicingMetaData extends PPModel
/**
* Actor who cancelled the resource.
*
* @deprecated Instead use setCancelledBy
*
* @param string $cancelled_by
* @deprecated. Instead use setCancelledBy
* @return $this
*/
public function setCancelled_by($cancelled_by)
{
@@ -173,9 +208,9 @@ class InvoicingMetaData extends PPModel
/**
* Actor who cancelled the resource.
* @deprecated Instead use getCancelledBy
*
* @return string
* @deprecated. Instead use getCancelledBy
*/
public function getCancelled_by()
{
@@ -186,6 +221,8 @@ class InvoicingMetaData extends PPModel
* Date when the resource was last edited.
*
* @param string $last_updated_date
*
* @return $this
*/
public function setLastUpdatedDate($last_updated_date)
{
@@ -206,8 +243,10 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was last edited.
*
* @deprecated Instead use setLastUpdatedDate
*
* @param string $last_updated_date
* @deprecated. Instead use setLastUpdatedDate
* @return $this
*/
public function setLast_updated_date($last_updated_date)
{
@@ -217,9 +256,9 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was last edited.
* @deprecated Instead use getLastUpdatedDate
*
* @return string
* @deprecated. Instead use getLastUpdatedDate
*/
public function getLast_updated_date()
{
@@ -230,6 +269,8 @@ class InvoicingMetaData extends PPModel
* Email address of the account that last edited the resource.
*
* @param string $last_updated_by
*
* @return $this
*/
public function setLastUpdatedBy($last_updated_by)
{
@@ -250,8 +291,10 @@ class InvoicingMetaData extends PPModel
/**
* Email address of the account that last edited the resource.
*
* @deprecated Instead use setLastUpdatedBy
*
* @param string $last_updated_by
* @deprecated. Instead use setLastUpdatedBy
* @return $this
*/
public function setLast_updated_by($last_updated_by)
{
@@ -261,9 +304,9 @@ class InvoicingMetaData extends PPModel
/**
* Email address of the account that last edited the resource.
* @deprecated Instead use getLastUpdatedBy
*
* @return string
* @deprecated. Instead use getLastUpdatedBy
*/
public function getLast_updated_by()
{
@@ -274,6 +317,8 @@ class InvoicingMetaData extends PPModel
* Date when the resource was first sent.
*
* @param string $first_sent_date
*
* @return $this
*/
public function setFirstSentDate($first_sent_date)
{
@@ -294,8 +339,10 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was first sent.
*
* @deprecated Instead use setFirstSentDate
*
* @param string $first_sent_date
* @deprecated. Instead use setFirstSentDate
* @return $this
*/
public function setFirst_sent_date($first_sent_date)
{
@@ -305,9 +352,9 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was first sent.
* @deprecated Instead use getFirstSentDate
*
* @return string
* @deprecated. Instead use getFirstSentDate
*/
public function getFirst_sent_date()
{
@@ -318,6 +365,8 @@ class InvoicingMetaData extends PPModel
* Date when the resource was last sent.
*
* @param string $last_sent_date
*
* @return $this
*/
public function setLastSentDate($last_sent_date)
{
@@ -338,8 +387,10 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was last sent.
*
* @deprecated Instead use setLastSentDate
*
* @param string $last_sent_date
* @deprecated. Instead use setLastSentDate
* @return $this
*/
public function setLast_sent_date($last_sent_date)
{
@@ -349,9 +400,9 @@ class InvoicingMetaData extends PPModel
/**
* Date when the resource was last sent.
* @deprecated Instead use getLastSentDate
*
* @return string
* @deprecated. Instead use getLastSentDate
*/
public function getLast_sent_date()
{
@@ -362,6 +413,8 @@ class InvoicingMetaData extends PPModel
* Email address of the account that last sent the resource.
*
* @param string $last_sent_by
*
* @return $this
*/
public function setLastSentBy($last_sent_by)
{
@@ -382,8 +435,10 @@ class InvoicingMetaData extends PPModel
/**
* Email address of the account that last sent the resource.
*
* @deprecated Instead use setLastSentBy
*
* @param string $last_sent_by
* @deprecated. Instead use setLastSentBy
* @return $this
*/
public function setLast_sent_by($last_sent_by)
{
@@ -393,13 +448,62 @@ class InvoicingMetaData extends PPModel
/**
* Email address of the account that last sent the resource.
* @deprecated Instead use getLastSentBy
*
* @return string
* @deprecated. Instead use getLastSentBy
*/
public function getLast_sent_by()
{
return $this->last_sent_by;
}
/**
* URL representing the payer's view of the invoice.
*
* @param string $payer_view_url
* @throws \InvalidArgumentException
* @return $this
*/
public function setPayerViewUrl($payer_view_url)
{
UrlValidator::validate($payer_view_url, "PayerViewUrl");
$this->payer_view_url = $payer_view_url;
return $this;
}
/**
* URL representing the payer's view of the invoice.
*
* @return string
*/
public function getPayerViewUrl()
{
return $this->payer_view_url;
}
/**
* URL representing the payer's view of the invoice.
*
* @deprecated Instead use setPayerViewUrl
*
* @param string $payer_view_url
* @return $this
*/
public function setPayer_view_url($payer_view_url)
{
$this->payer_view_url = $payer_view_url;
return $this;
}
/**
* URL representing the payer's view of the invoice.
* @deprecated Instead use getPayerViewUrl
*
* @return string
*/
public function getPayer_view_url()
{
return $this->payer_view_url;
}
}

35
lib/PayPal/Api/InvoicingNotification.php
View File

@@ -1,15 +1,28 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class InvoicingNotification
*
* Email/SMS notification.
*
* @package PayPal\Api
*
* @property string subject
* @property string note
* @property bool send_to_merchant
*/
class InvoicingNotification extends PPModel
{
/**
* Subject of the notification.
*
* @param string $subject
*
* @return $this
*/
public function setSubject($subject)
{
@@ -27,11 +40,12 @@ class InvoicingNotification extends PPModel
return $this->subject;
}
/**
* Note to the payer.
*
* @param string $note
*
* @return $this
*/
public function setNote($note)
{
@@ -49,11 +63,12 @@ class InvoicingNotification extends PPModel
return $this->note;
}
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @param boolean $send_to_merchant
* @param bool $send_to_merchant
*
* @return $this
*/
public function setSendToMerchant($send_to_merchant)
{
@@ -64,7 +79,7 @@ class InvoicingNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @return boolean
* @return bool
*/
public function getSendToMerchant()
{
@@ -74,8 +89,10 @@ class InvoicingNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @param boolean $send_to_merchant
* @deprecated. Instead use setSendToMerchant
* @deprecated Instead use setSendToMerchant
*
* @param bool $send_to_merchant
* @return $this
*/
public function setSend_to_merchant($send_to_merchant)
{
@@ -85,9 +102,9 @@ class InvoicingNotification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
* @deprecated Instead use getSendToMerchant
*
* @return boolean
* @deprecated. Instead use getSendToMerchant
* @return bool
*/
public function getSend_to_merchant()
{

55
lib/PayPal/Api/InvoicingPaymentDetail.php
View File

@@ -1,15 +1,32 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class InvoicingPaymentDetail
*
* Invoicing payment information.
*
* @package PayPal\Api
*
* @property string type
* @property string transaction_id
* @property string transaction_type
* @property string date
* @property string method
* @property string note
*/
class InvoicingPaymentDetail extends PPModel
{
/**
* 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.
* Valid Values: ["PAYPAL", "EXTERNAL"]
*
* @param string $type
*
* @return $this
*/
public function setType($type)
{
@@ -27,11 +44,12 @@ class InvoicingPaymentDetail extends PPModel
return $this->type;
}
/**
* PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
*
* @param string $transaction_id
*
* @return $this
*/
public function setTransactionId($transaction_id)
{
@@ -52,8 +70,10 @@ class InvoicingPaymentDetail extends PPModel
/**
* PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
*
* @deprecated Instead use setTransactionId
*
* @param string $transaction_id
* @deprecated. Instead use setTransactionId
* @return $this
*/
public function setTransaction_id($transaction_id)
{
@@ -63,9 +83,9 @@ class InvoicingPaymentDetail extends PPModel
/**
* PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
* @deprecated Instead use getTransactionId
*
* @return string
* @deprecated. Instead use getTransactionId
*/
public function getTransaction_id()
{
@@ -74,8 +94,11 @@ class InvoicingPaymentDetail extends PPModel
/**
* Type of the transaction.
* Valid Values: ["SALE", "AUTHORIZATION", "CAPTURE"]
*
* @param string $transaction_type
*
* @return $this
*/
public function setTransactionType($transaction_type)
{
@@ -96,8 +119,10 @@ class InvoicingPaymentDetail extends PPModel
/**
* Type of the transaction.
*
* @deprecated Instead use setTransactionType
*
* @param string $transaction_type
* @deprecated. Instead use setTransactionType
* @return $this
*/
public function setTransaction_type($transaction_type)
{
@@ -107,9 +132,9 @@ class InvoicingPaymentDetail extends PPModel
/**
* Type of the transaction.
* @deprecated Instead use getTransactionType
*
* @return string
* @deprecated. Instead use getTransactionType
*/
public function getTransaction_type()
{
@@ -117,9 +142,11 @@ class InvoicingPaymentDetail extends PPModel
}
/**
* Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
* 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).
*
* @param string $date
*
* @return $this
*/
public function setDate($date)
{
@@ -128,7 +155,7 @@ class InvoicingPaymentDetail extends PPModel
}
/**
* Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
* 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).
*
* @return string
*/
@@ -137,11 +164,13 @@ class InvoicingPaymentDetail extends PPModel
return $this->date;
}
/**
* Payment mode or method. This field is mandatory if the value of the type field is OTHER.
* Payment mode or method. This field is mandatory if the value of the type field is EXTERNAL.
* Valid Values: ["BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"]
*
* @param string $method
*
* @return $this
*/
public function setMethod($method)
{
@@ -150,7 +179,7 @@ class InvoicingPaymentDetail extends PPModel
}
/**
* Payment mode or method. This field is mandatory if the value of the type field is OTHER.
* Payment mode or method. This field is mandatory if the value of the type field is EXTERNAL.
*
* @return string
*/
@@ -159,11 +188,12 @@ class InvoicingPaymentDetail extends PPModel
return $this->method;
}
/**
* Optional note associated with the payment.
*
* @param string $note
*
* @return $this
*/
public function setNote($note)
{
@@ -181,5 +211,4 @@ class InvoicingPaymentDetail extends PPModel
return $this->note;
}
}

27
lib/PayPal/Api/InvoicingRefundDetail.php
View File

@@ -1,15 +1,29 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class InvoicingRefundDetail
*
* Invoicing refund information.
*
* @package PayPal\Api
*
* @property string type
* @property string date
* @property string note
*/
class InvoicingRefundDetail extends PPModel
{
/**
* 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.
* Valid Values: ["PAYPAL", "EXTERNAL"]
*
* @param string $type
*
* @return $this
*/
public function setType($type)
{
@@ -27,11 +41,12 @@ class InvoicingRefundDetail extends PPModel
return $this->type;
}
/**
* Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date.
* 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).
*
* @param string $date
*
* @return $this
*/
public function setDate($date)
{
@@ -40,7 +55,7 @@ class InvoicingRefundDetail extends PPModel
}
/**
* 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 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).
*
* @return string
*/
@@ -49,11 +64,12 @@ class InvoicingRefundDetail extends PPModel
return $this->date;
}
/**
* Optional note associated with the refund.
*
* @param string $note
*
* @return $this
*/
public function setNote($note)
{
@@ -71,5 +87,4 @@ class InvoicingRefundDetail extends PPModel
return $this->note;
}
}

262
lib/PayPal/Api/InvoicingSearch.php
View File

@@ -1,15 +1,44 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class InvoicingSearch
*
* Invoice search parameters.
*
* @package PayPal\Api
*
* @property string email
* @property string recipient_first_name
* @property string recipient_last_name
* @property string recipient_business_name
* @property string number
* @property string status
* @property \PayPal\Api\Currency lower_total_amount
* @property \PayPal\Api\Currency upper_total_amount
* @property string start_invoice_date
* @property string end_invoice_date
* @property string start_due_date
* @property string end_due_date
* @property string start_payment_date
* @property string end_payment_date
* @property string start_creation_date
* @property string end_creation_date
* @property \PayPal\Api\number page
* @property \PayPal\Api\number page_size
* @property bool total_count_required
*/
class InvoicingSearch extends PPModel
{
/**
* Initial letters of the email address.
*
* @param string $email
*
* @return $this
*/
public function setEmail($email)
{
@@ -27,11 +56,12 @@ class InvoicingSearch extends PPModel
return $this->email;
}
/**
* Initial letters of the recipient's first name.
*
* @param string $recipient_first_name
*
* @return $this
*/
public function setRecipientFirstName($recipient_first_name)
{
@@ -52,8 +82,10 @@ class InvoicingSearch extends PPModel
/**
* Initial letters of the recipient's first name.
*
* @deprecated Instead use setRecipientFirstName
*
* @param string $recipient_first_name
* @deprecated. Instead use setRecipientFirstName
* @return $this
*/
public function setRecipient_first_name($recipient_first_name)
{
@@ -63,9 +95,9 @@ class InvoicingSearch extends PPModel
/**
* Initial letters of the recipient's first name.
* @deprecated Instead use getRecipientFirstName
*
* @return string
* @deprecated. Instead use getRecipientFirstName
*/
public function getRecipient_first_name()
{
@@ -76,6 +108,8 @@ class InvoicingSearch extends PPModel
* Initial letters of the recipient's last name.
*
* @param string $recipient_last_name
*
* @return $this
*/
public function setRecipientLastName($recipient_last_name)
{
@@ -96,8 +130,10 @@ class InvoicingSearch extends PPModel
/**
* Initial letters of the recipient's last name.
*
* @deprecated Instead use setRecipientLastName
*
* @param string $recipient_last_name
* @deprecated. Instead use setRecipientLastName
* @return $this
*/
public function setRecipient_last_name($recipient_last_name)
{
@@ -107,9 +143,9 @@ class InvoicingSearch extends PPModel
/**
* Initial letters of the recipient's last name.
* @deprecated Instead use getRecipientLastName
*
* @return string
* @deprecated. Instead use getRecipientLastName
*/
public function getRecipient_last_name()
{
@@ -120,6 +156,8 @@ class InvoicingSearch extends PPModel
* Initial letters of the recipient's business name.
*
* @param string $recipient_business_name
*
* @return $this
*/
public function setRecipientBusinessName($recipient_business_name)
{
@@ -140,8 +178,10 @@ class InvoicingSearch extends PPModel
/**
* Initial letters of the recipient's business name.
*
* @deprecated Instead use setRecipientBusinessName
*
* @param string $recipient_business_name
* @deprecated. Instead use setRecipientBusinessName
* @return $this
*/
public function setRecipient_business_name($recipient_business_name)
{
@@ -151,9 +191,9 @@ class InvoicingSearch extends PPModel
/**
* Initial letters of the recipient's business name.
* @deprecated Instead use getRecipientBusinessName
*
* @return string
* @deprecated. Instead use getRecipientBusinessName
*/
public function getRecipient_business_name()
{
@@ -164,6 +204,8 @@ class InvoicingSearch extends PPModel
* The invoice number that appears on the invoice.
*
* @param string $number
*
* @return $this
*/
public function setNumber($number)
{
@@ -181,11 +223,13 @@ class InvoicingSearch extends PPModel
return $this->number;
}
/**
* 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)
{
@@ -203,11 +247,12 @@ class InvoicingSearch extends PPModel
return $this->status;
}
/**
* Lower limit of total amount.
*
* @param PayPal\Api\Currency $lower_total_amount
* @param \PayPal\Api\Currency $lower_total_amount
*
* @return $this
*/
public function setLowerTotalAmount($lower_total_amount)
{
@@ -218,7 +263,7 @@ class InvoicingSearch extends PPModel
/**
* Lower limit of total amount.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getLowerTotalAmount()
{
@@ -228,8 +273,10 @@ class InvoicingSearch extends PPModel
/**
* Lower limit of total amount.
*
* @param PayPal\Api\Currency $lower_total_amount
* @deprecated. Instead use setLowerTotalAmount
* @deprecated Instead use setLowerTotalAmount
*
* @param \PayPal\Api\Currency $lower_total_amount
* @return $this
*/
public function setLower_total_amount($lower_total_amount)
{
@@ -239,9 +286,9 @@ class InvoicingSearch extends PPModel
/**
* Lower limit of total amount.
* @deprecated Instead use getLowerTotalAmount
*
* @return PayPal\Api\Currency
* @deprecated. Instead use getLowerTotalAmount
* @return \PayPal\Api\Currency
*/
public function getLower_total_amount()
{
@@ -251,7 +298,9 @@ class InvoicingSearch extends PPModel
/**
* Upper limit of total amount.
*
* @param PayPal\Api\Currency $upper_total_amount
* @param \PayPal\Api\Currency $upper_total_amount
*
* @return $this
*/
public function setUpperTotalAmount($upper_total_amount)
{
@@ -262,7 +311,7 @@ class InvoicingSearch extends PPModel
/**
* Upper limit of total amount.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getUpperTotalAmount()
{
@@ -272,8 +321,10 @@ class InvoicingSearch extends PPModel
/**
* Upper limit of total amount.
*
* @param PayPal\Api\Currency $upper_total_amount
* @deprecated. Instead use setUpperTotalAmount
* @deprecated Instead use setUpperTotalAmount
*
* @param \PayPal\Api\Currency $upper_total_amount
* @return $this
*/
public function setUpper_total_amount($upper_total_amount)
{
@@ -283,9 +334,9 @@ class InvoicingSearch extends PPModel
/**
* Upper limit of total amount.
* @deprecated Instead use getUpperTotalAmount
*
* @return PayPal\Api\Currency
* @deprecated. Instead use getUpperTotalAmount
* @return \PayPal\Api\Currency
*/
public function getUpper_total_amount()
{
@@ -293,9 +344,11 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
*
* @param string $start_invoice_date
*
* @return $this
*/
public function setStartInvoiceDate($start_invoice_date)
{
@@ -304,7 +357,7 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
*
* @return string
*/
@@ -314,10 +367,12 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
*
* @deprecated Instead use setStartInvoiceDate
*
* @param string $start_invoice_date
* @deprecated. Instead use setStartInvoiceDate
* @return $this
*/
public function setStart_invoice_date($start_invoice_date)
{
@@ -326,10 +381,10 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
* @deprecated Instead use getStartInvoiceDate
*
* @return string
* @deprecated. Instead use getStartInvoiceDate
*/
public function getStart_invoice_date()
{
@@ -337,9 +392,11 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
*
* @param string $end_invoice_date
*
* @return $this
*/
public function setEndInvoiceDate($end_invoice_date)
{
@@ -348,7 +405,7 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
*
* @return string
*/
@@ -358,10 +415,12 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
*
* @deprecated Instead use setEndInvoiceDate
*
* @param string $end_invoice_date
* @deprecated. Instead use setEndInvoiceDate
* @return $this
*/
public function setEnd_invoice_date($end_invoice_date)
{
@@ -370,10 +429,10 @@ class InvoicingSearch extends PPModel
}
/**
* 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).
* @deprecated Instead use getEndInvoiceDate
*
* @return string
* @deprecated. Instead use getEndInvoiceDate
*/
public function getEnd_invoice_date()
{
@@ -381,9 +440,11 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @param string $start_due_date
*
* @return $this
*/
public function setStartDueDate($start_due_date)
{
@@ -392,7 +453,7 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @return string
*/
@@ -402,10 +463,12 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @deprecated Instead use setStartDueDate
*
* @param string $start_due_date
* @deprecated. Instead use setStartDueDate
* @return $this
*/
public function setStart_due_date($start_due_date)
{
@@ -414,10 +477,10 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
* @deprecated Instead use getStartDueDate
*
* @return string
* @deprecated. Instead use getStartDueDate
*/
public function getStart_due_date()
{
@@ -425,9 +488,11 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @param string $end_due_date
*
* @return $this
*/
public function setEndDueDate($end_due_date)
{
@@ -436,7 +501,7 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @return string
*/
@@ -446,10 +511,12 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @deprecated Instead use setEndDueDate
*
* @param string $end_due_date
* @deprecated. Instead use setEndDueDate
* @return $this
*/
public function setEnd_due_date($end_due_date)
{
@@ -458,10 +525,10 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
* @deprecated Instead use getEndDueDate
*
* @return string
* @deprecated. Instead use getEndDueDate
*/
public function getEnd_due_date()
{
@@ -469,9 +536,11 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @param string $start_payment_date
*
* @return $this
*/
public function setStartPaymentDate($start_payment_date)
{
@@ -480,7 +549,7 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @return string
*/
@@ -490,10 +559,12 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @deprecated Instead use setStartPaymentDate
*
* @param string $start_payment_date
* @deprecated. Instead use setStartPaymentDate
* @return $this
*/
public function setStart_payment_date($start_payment_date)
{
@@ -502,10 +573,10 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
* @deprecated Instead use getStartPaymentDate
*
* @return string
* @deprecated. Instead use getStartPaymentDate
*/
public function getStart_payment_date()
{
@@ -513,9 +584,11 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @param string $end_payment_date
*
* @return $this
*/
public function setEndPaymentDate($end_payment_date)
{
@@ -524,7 +597,7 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @return string
*/
@@ -534,10 +607,12 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @deprecated Instead use setEndPaymentDate
*
* @param string $end_payment_date
* @deprecated. Instead use setEndPaymentDate
* @return $this
*/
public function setEnd_payment_date($end_payment_date)
{
@@ -546,10 +621,10 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
* @deprecated Instead use getEndPaymentDate
*
* @return string
* @deprecated. Instead use getEndPaymentDate
*/
public function getEnd_payment_date()
{
@@ -557,9 +632,11 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @param string $start_creation_date
*
* @return $this
*/
public function setStartCreationDate($start_creation_date)
{
@@ -568,7 +645,7 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @return string
*/
@@ -578,10 +655,12 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
*
* @deprecated Instead use setStartCreationDate
*
* @param string $start_creation_date
* @deprecated. Instead use setStartCreationDate
* @return $this
*/
public function setStart_creation_date($start_creation_date)
{
@@ -590,10 +669,10 @@ class InvoicingSearch extends PPModel
}
/**
* Start invoice 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).
* @deprecated Instead use getStartCreationDate
*
* @return string
* @deprecated. Instead use getStartCreationDate
*/
public function getStart_creation_date()
{
@@ -601,9 +680,11 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @param string $end_creation_date
*
* @return $this
*/
public function setEndCreationDate($end_creation_date)
{
@@ -612,7 +693,7 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @return string
*/
@@ -622,10 +703,12 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
*
* @deprecated Instead use setEndCreationDate
*
* @param string $end_creation_date
* @deprecated. Instead use setEndCreationDate
* @return $this
*/
public function setEnd_creation_date($end_creation_date)
{
@@ -634,10 +717,10 @@ class InvoicingSearch extends PPModel
}
/**
* End invoice 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).
* @deprecated Instead use getEndCreationDate
*
* @return string
* @deprecated. Instead use getEndCreationDate
*/
public function getEnd_creation_date()
{
@@ -647,7 +730,9 @@ class InvoicingSearch extends PPModel
/**
* Offset of the search results.
*
* @param PayPal\Api\number $page
* @param \PayPal\Api\number $page
*
* @return $this
*/
public function setPage($page)
{
@@ -658,18 +743,19 @@ class InvoicingSearch extends PPModel
/**
* Offset of the search results.
*
* @return PayPal\Api\number
* @return \PayPal\Api\number
*/
public function getPage()
{
return $this->page;
}
/**
* Page size of the search results.
*
* @param PayPal\Api\number $page_size
* @param \PayPal\Api\number $page_size
*
* @return $this
*/
public function setPageSize($page_size)
{
@@ -680,7 +766,7 @@ class InvoicingSearch extends PPModel
/**
* Page size of the search results.
*
* @return PayPal\Api\number
* @return \PayPal\Api\number
*/
public function getPageSize()
{
@@ -690,8 +776,10 @@ class InvoicingSearch extends PPModel
/**
* Page size of the search results.
*
* @param PayPal\Api\number $page_size
* @deprecated. Instead use setPageSize
* @deprecated Instead use setPageSize
*
* @param \PayPal\Api\number $page_size
* @return $this
*/
public function setPage_size($page_size)
{
@@ -701,9 +789,9 @@ class InvoicingSearch extends PPModel
/**
* Page size of the search results.
* @deprecated Instead use getPageSize
*
* @return PayPal\Api\number
* @deprecated. Instead use getPageSize
* @return \PayPal\Api\number
*/
public function getPage_size()
{
@@ -713,7 +801,9 @@ class InvoicingSearch extends PPModel
/**
* A flag indicating whether total count is required in the response.
*
* @param boolean $total_count_required
* @param bool $total_count_required
*
* @return $this
*/
public function setTotalCountRequired($total_count_required)
{
@@ -724,7 +814,7 @@ class InvoicingSearch extends PPModel
/**
* A flag indicating whether total count is required in the response.
*
* @return boolean
* @return bool
*/
public function getTotalCountRequired()
{
@@ -734,8 +824,10 @@ class InvoicingSearch extends PPModel
/**
* A flag indicating whether total count is required in the response.
*
* @param boolean $total_count_required
* @deprecated. Instead use setTotalCountRequired
* @deprecated Instead use setTotalCountRequired
*
* @param bool $total_count_required
* @return $this
*/
public function setTotal_count_required($total_count_required)
{
@@ -745,9 +837,9 @@ class InvoicingSearch extends PPModel
/**
* A flag indicating whether total count is required in the response.
* @deprecated Instead use getTotalCountRequired
*
* @return boolean
* @deprecated. Instead use getTotalCountRequired
* @return bool
*/
public function getTotal_count_required()
{

87
lib/PayPal/Api/MerchantInfo.php
View File

@@ -1,15 +1,35 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class MerchantInfo
*
* Business information of the merchant that will appear on the invoice.
*
* @package PayPal\Api
*
* @property string email
* @property string first_name
* @property string last_name
* @property \PayPal\Api\Address address
* @property string business_name
* @property \PayPal\Api\Phone phone
* @property \PayPal\Api\Phone fax
* @property string website
* @property string tax_id
* @property string additional_info
*/
class MerchantInfo extends PPModel
{
/**
* Email address of the merchant. 260 characters max.
*
* @param string $email
*
* @return $this
*/
public function setEmail($email)
{
@@ -27,11 +47,12 @@ class MerchantInfo extends PPModel
return $this->email;
}
/**
* First name of the merchant. 30 characters max.
*
* @param string $first_name
*
* @return $this
*/
public function setFirstName($first_name)
{
@@ -52,8 +73,10 @@ class MerchantInfo extends PPModel
/**
* First name of the merchant. 30 characters max.
*
* @deprecated Instead use setFirstName
*
* @param string $first_name
* @deprecated. Instead use setFirstName
* @return $this
*/
public function setFirst_name($first_name)
{
@@ -63,9 +86,9 @@ class MerchantInfo extends PPModel
/**
* First name of the merchant. 30 characters max.
* @deprecated Instead use getFirstName
*
* @return string
* @deprecated. Instead use getFirstName
*/
public function getFirst_name()
{
@@ -76,6 +99,8 @@ class MerchantInfo extends PPModel
* Last name of the merchant. 30 characters max.
*
* @param string $last_name
*
* @return $this
*/
public function setLastName($last_name)
{
@@ -96,8 +121,10 @@ class MerchantInfo extends PPModel
/**
* Last name of the merchant. 30 characters max.
*
* @deprecated Instead use setLastName
*
* @param string $last_name
* @deprecated. Instead use setLastName
* @return $this
*/
public function setLast_name($last_name)
{
@@ -107,9 +134,9 @@ class MerchantInfo extends PPModel
/**
* Last name of the merchant. 30 characters max.
* @deprecated Instead use getLastName
*
* @return string
* @deprecated. Instead use getLastName
*/
public function getLast_name()
{
@@ -119,7 +146,9 @@ class MerchantInfo extends PPModel
/**
* Address of the merchant.
*
* @param PayPal\Api\Address $address
* @param \PayPal\Api\Address $address
*
* @return $this
*/
public function setAddress($address)
{
@@ -130,18 +159,19 @@ class MerchantInfo extends PPModel
/**
* Address of the merchant.
*
* @return PayPal\Api\Address
* @return \PayPal\Api\Address
*/
public function getAddress()
{
return $this->address;
}
/**
* Company business name of the merchant. 100 characters max.
*
* @param string $business_name
*
* @return $this
*/
public function setBusinessName($business_name)
{
@@ -162,8 +192,10 @@ class MerchantInfo extends PPModel
/**
* Company business name of the merchant. 100 characters max.
*
* @deprecated Instead use setBusinessName
*
* @param string $business_name
* @deprecated. Instead use setBusinessName
* @return $this
*/
public function setBusiness_name($business_name)
{
@@ -173,9 +205,9 @@ class MerchantInfo extends PPModel
/**
* Company business name of the merchant. 100 characters max.
* @deprecated Instead use getBusinessName
*
* @return string
* @deprecated. Instead use getBusinessName
*/
public function getBusiness_name()
{
@@ -185,7 +217,9 @@ class MerchantInfo extends PPModel
/**
* Phone number of the merchant.
*
* @param PayPal\Api\Phone $phone
* @param \PayPal\Api\Phone $phone
*
* @return $this
*/
public function setPhone($phone)
{
@@ -196,18 +230,19 @@ class MerchantInfo extends PPModel
/**
* Phone number of the merchant.
*
* @return PayPal\Api\Phone
* @return \PayPal\Api\Phone
*/
public function getPhone()
{
return $this->phone;
}
/**
* Fax number of the merchant.
*
* @param PayPal\Api\Phone $fax
* @param \PayPal\Api\Phone $fax
*
* @return $this
*/
public function setFax($fax)
{
@@ -218,18 +253,19 @@ class MerchantInfo extends PPModel
/**
* Fax number of the merchant.
*
* @return PayPal\Api\Phone
* @return \PayPal\Api\Phone
*/
public function getFax()
{
return $this->fax;
}
/**
* Website of the merchant. 2048 characters max.
*
* @param string $website
*
* @return $this
*/
public function setWebsite($website)
{
@@ -247,11 +283,12 @@ class MerchantInfo extends PPModel
return $this->website;
}
/**
* Tax ID of the merchant. 100 characters max.
*
* @param string $tax_id
*
* @return $this
*/
public function setTaxId($tax_id)
{
@@ -272,8 +309,10 @@ class MerchantInfo extends PPModel
/**
* Tax ID of the merchant. 100 characters max.
*
* @deprecated Instead use setTaxId
*
* @param string $tax_id
* @deprecated. Instead use setTaxId
* @return $this
*/
public function setTax_id($tax_id)
{
@@ -283,9 +322,9 @@ class MerchantInfo extends PPModel
/**
* Tax ID of the merchant. 100 characters max.
* @deprecated Instead use getTaxId
*
* @return string
* @deprecated. Instead use getTaxId
*/
public function getTax_id()
{
@@ -296,6 +335,8 @@ class MerchantInfo extends PPModel
* Option to display additional information such as business hours. 40 characters max.
*
* @param string $additional_info
*
* @return $this
*/
public function setAdditionalInfo($additional_info)
{
@@ -316,8 +357,10 @@ class MerchantInfo extends PPModel
/**
* Option to display additional information such as business hours. 40 characters max.
*
* @deprecated Instead use setAdditionalInfo
*
* @param string $additional_info
* @deprecated. Instead use setAdditionalInfo
* @return $this
*/
public function setAdditional_info($additional_info)
{
@@ -327,9 +370,9 @@ class MerchantInfo extends PPModel
/**
* Option to display additional information such as business hours. 40 characters max.
* @deprecated Instead use getAdditionalInfo
*
* @return string
* @deprecated. Instead use getAdditionalInfo
*/
public function getAdditional_info()
{

142
lib/PayPal/Api/Metadata.php
View File

@@ -1,15 +1,36 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
use PayPal\Validation\UrlValidator;
/**
* Class Metadata
*
* Audit information of the resource.
*
* @package PayPal\Api
*
* @property string created_date
* @property string created_by
* @property string cancelled_date
* @property string cancelled_by
* @property string last_updated_date
* @property string last_updated_by
* @property string first_sent_date
* @property string last_sent_date
* @property string last_sent_by
* @property string payer_view_url
*/
class Metadata extends PPModel
{
/**
* Date when the resource was created.
*
* @param string $created_date
*
* @return $this
*/
public function setCreatedDate($created_date)
{
@@ -30,8 +51,10 @@ class Metadata extends PPModel
/**
* Date when the resource was created.
*
* @deprecated Instead use setCreatedDate
*
* @param string $created_date
* @deprecated. Instead use setCreatedDate
* @return $this
*/
public function setCreated_date($created_date)
{
@@ -41,9 +64,9 @@ class Metadata extends PPModel
/**
* Date when the resource was created.
* @deprecated Instead use getCreatedDate
*
* @return string
* @deprecated. Instead use getCreatedDate
*/
public function getCreated_date()
{
@@ -54,6 +77,8 @@ class Metadata extends PPModel
* Email address of the account that created the resource.
*
* @param string $created_by
*
* @return $this
*/
public function setCreatedBy($created_by)
{
@@ -74,8 +99,10 @@ class Metadata extends PPModel
/**
* Email address of the account that created the resource.
*
* @deprecated Instead use setCreatedBy
*
* @param string $created_by
* @deprecated. Instead use setCreatedBy
* @return $this
*/
public function setCreated_by($created_by)
{
@@ -85,9 +112,9 @@ class Metadata extends PPModel
/**
* Email address of the account that created the resource.
* @deprecated Instead use getCreatedBy
*
* @return string
* @deprecated. Instead use getCreatedBy
*/
public function getCreated_by()
{
@@ -98,6 +125,8 @@ class Metadata extends PPModel
* Date when the resource was cancelled.
*
* @param string $cancelled_date
*
* @return $this
*/
public function setCancelledDate($cancelled_date)
{
@@ -118,8 +147,10 @@ class Metadata extends PPModel
/**
* Date when the resource was cancelled.
*
* @deprecated Instead use setCancelledDate
*
* @param string $cancelled_date
* @deprecated. Instead use setCancelledDate
* @return $this
*/
public function setCancelled_date($cancelled_date)
{
@@ -129,9 +160,9 @@ class Metadata extends PPModel
/**
* Date when the resource was cancelled.
* @deprecated Instead use getCancelledDate
*
* @return string
* @deprecated. Instead use getCancelledDate
*/
public function getCancelled_date()
{
@@ -142,6 +173,8 @@ class Metadata extends PPModel
* Actor who cancelled the resource.
*
* @param string $cancelled_by
*
* @return $this
*/
public function setCancelledBy($cancelled_by)
{
@@ -162,8 +195,10 @@ class Metadata extends PPModel
/**
* Actor who cancelled the resource.
*
* @deprecated Instead use setCancelledBy
*
* @param string $cancelled_by
* @deprecated. Instead use setCancelledBy
* @return $this
*/
public function setCancelled_by($cancelled_by)
{
@@ -173,9 +208,9 @@ class Metadata extends PPModel
/**
* Actor who cancelled the resource.
* @deprecated Instead use getCancelledBy
*
* @return string
* @deprecated. Instead use getCancelledBy
*/
public function getCancelled_by()
{
@@ -186,6 +221,8 @@ class Metadata extends PPModel
* Date when the resource was last edited.
*
* @param string $last_updated_date
*
* @return $this
*/
public function setLastUpdatedDate($last_updated_date)
{
@@ -206,8 +243,10 @@ class Metadata extends PPModel
/**
* Date when the resource was last edited.
*
* @deprecated Instead use setLastUpdatedDate
*
* @param string $last_updated_date
* @deprecated. Instead use setLastUpdatedDate
* @return $this
*/
public function setLast_updated_date($last_updated_date)
{
@@ -217,9 +256,9 @@ class Metadata extends PPModel
/**
* Date when the resource was last edited.
* @deprecated Instead use getLastUpdatedDate
*
* @return string
* @deprecated. Instead use getLastUpdatedDate
*/
public function getLast_updated_date()
{
@@ -230,6 +269,8 @@ class Metadata extends PPModel
* Email address of the account that last edited the resource.
*
* @param string $last_updated_by
*
* @return $this
*/
public function setLastUpdatedBy($last_updated_by)
{
@@ -250,8 +291,10 @@ class Metadata extends PPModel
/**
* Email address of the account that last edited the resource.
*
* @deprecated Instead use setLastUpdatedBy
*
* @param string $last_updated_by
* @deprecated. Instead use setLastUpdatedBy
* @return $this
*/
public function setLast_updated_by($last_updated_by)
{
@@ -261,9 +304,9 @@ class Metadata extends PPModel
/**
* Email address of the account that last edited the resource.
* @deprecated Instead use getLastUpdatedBy
*
* @return string
* @deprecated. Instead use getLastUpdatedBy
*/
public function getLast_updated_by()
{
@@ -274,6 +317,8 @@ class Metadata extends PPModel
* Date when the resource was first sent.
*
* @param string $first_sent_date
*
* @return $this
*/
public function setFirstSentDate($first_sent_date)
{
@@ -294,8 +339,10 @@ class Metadata extends PPModel
/**
* Date when the resource was first sent.
*
* @deprecated Instead use setFirstSentDate
*
* @param string $first_sent_date
* @deprecated. Instead use setFirstSentDate
* @return $this
*/
public function setFirst_sent_date($first_sent_date)
{
@@ -305,9 +352,9 @@ class Metadata extends PPModel
/**
* Date when the resource was first sent.
* @deprecated Instead use getFirstSentDate
*
* @return string
* @deprecated. Instead use getFirstSentDate
*/
public function getFirst_sent_date()
{
@@ -318,6 +365,8 @@ class Metadata extends PPModel
* Date when the resource was last sent.
*
* @param string $last_sent_date
*
* @return $this
*/
public function setLastSentDate($last_sent_date)
{
@@ -338,8 +387,10 @@ class Metadata extends PPModel
/**
* Date when the resource was last sent.
*
* @deprecated Instead use setLastSentDate
*
* @param string $last_sent_date
* @deprecated. Instead use setLastSentDate
* @return $this
*/
public function setLast_sent_date($last_sent_date)
{
@@ -349,9 +400,9 @@ class Metadata extends PPModel
/**
* Date when the resource was last sent.
* @deprecated Instead use getLastSentDate
*
* @return string
* @deprecated. Instead use getLastSentDate
*/
public function getLast_sent_date()
{
@@ -362,6 +413,8 @@ class Metadata extends PPModel
* Email address of the account that last sent the resource.
*
* @param string $last_sent_by
*
* @return $this
*/
public function setLastSentBy($last_sent_by)
{
@@ -382,8 +435,10 @@ class Metadata extends PPModel
/**
* Email address of the account that last sent the resource.
*
* @deprecated Instead use setLastSentBy
*
* @param string $last_sent_by
* @deprecated. Instead use setLastSentBy
* @return $this
*/
public function setLast_sent_by($last_sent_by)
{
@@ -393,13 +448,62 @@ class Metadata extends PPModel
/**
* Email address of the account that last sent the resource.
* @deprecated Instead use getLastSentBy
*
* @return string
* @deprecated. Instead use getLastSentBy
*/
public function getLast_sent_by()
{
return $this->last_sent_by;
}
/**
* URL representing the payer's view of the invoice.
*
* @param string $payer_view_url
* @throws \InvalidArgumentException
* @return $this
*/
public function setPayerViewUrl($payer_view_url)
{
UrlValidator::validate($payer_view_url, "PayerViewUrl");
$this->payer_view_url = $payer_view_url;
return $this;
}
/**
* URL representing the payer's view of the invoice.
*
* @return string
*/
public function getPayerViewUrl()
{
return $this->payer_view_url;
}
/**
* URL representing the payer's view of the invoice.
*
* @deprecated Instead use setPayerViewUrl
*
* @param string $payer_view_url
* @return $this
*/
public function setPayer_view_url($payer_view_url)
{
$this->payer_view_url = $payer_view_url;
return $this;
}
/**
* URL representing the payer's view of the invoice.
* @deprecated Instead use getPayerViewUrl
*
* @return string
*/
public function getPayer_view_url()
{
return $this->payer_view_url;
}
}

35
lib/PayPal/Api/Notification.php
View File

@@ -1,15 +1,28 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class Notification
*
* Email/SMS notification.
*
* @package PayPal\Api
*
* @property string subject
* @property string note
* @property bool send_to_merchant
*/
class Notification extends PPModel
{
/**
* Subject of the notification.
*
* @param string $subject
*
* @return $this
*/
public function setSubject($subject)
{
@@ -27,11 +40,12 @@ class Notification extends PPModel
return $this->subject;
}
/**
* Note to the payer.
*
* @param string $note
*
* @return $this
*/
public function setNote($note)
{
@@ -49,11 +63,12 @@ class Notification extends PPModel
return $this->note;
}
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @param boolean $send_to_merchant
* @param bool $send_to_merchant
*
* @return $this
*/
public function setSendToMerchant($send_to_merchant)
{
@@ -64,7 +79,7 @@ class Notification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @return boolean
* @return bool
*/
public function getSendToMerchant()
{
@@ -74,8 +89,10 @@ class Notification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
*
* @param boolean $send_to_merchant
* @deprecated. Instead use setSendToMerchant
* @deprecated Instead use setSendToMerchant
*
* @param bool $send_to_merchant
* @return $this
*/
public function setSend_to_merchant($send_to_merchant)
{
@@ -85,9 +102,9 @@ class Notification extends PPModel
/**
* A flag indicating whether a copy of the email has to be sent to the merchant.
* @deprecated Instead use getSendToMerchant
*
* @return boolean
* @deprecated. Instead use getSendToMerchant
* @return bool
*/
public function getSend_to_merchant()
{

55
lib/PayPal/Api/PaymentDetail.php
View File

@@ -1,15 +1,32 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class PaymentDetail
*
* Invoicing payment information.
*
* @package PayPal\Api
*
* @property string type
* @property string transaction_id
* @property string transaction_type
* @property string date
* @property string method
* @property string note
*/
class PaymentDetail extends PPModel
{
/**
* 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.
* Valid Values: ["PAYPAL", "EXTERNAL"]
*
* @param string $type
*
* @return $this
*/
public function setType($type)
{
@@ -27,11 +44,12 @@ class PaymentDetail extends PPModel
return $this->type;
}
/**
* PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
*
* @param string $transaction_id
*
* @return $this
*/
public function setTransactionId($transaction_id)
{
@@ -52,8 +70,10 @@ class PaymentDetail extends PPModel
/**
* PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
*
* @deprecated Instead use setTransactionId
*
* @param string $transaction_id
* @deprecated. Instead use setTransactionId
* @return $this
*/
public function setTransaction_id($transaction_id)
{
@@ -63,9 +83,9 @@ class PaymentDetail extends PPModel
/**
* PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
* @deprecated Instead use getTransactionId
*
* @return string
* @deprecated. Instead use getTransactionId
*/
public function getTransaction_id()
{
@@ -74,8 +94,11 @@ class PaymentDetail extends PPModel
/**
* Type of the transaction.
* Valid Values: ["SALE", "AUTHORIZATION", "CAPTURE"]
*
* @param string $transaction_type
*
* @return $this
*/
public function setTransactionType($transaction_type)
{
@@ -96,8 +119,10 @@ class PaymentDetail extends PPModel
/**
* Type of the transaction.
*
* @deprecated Instead use setTransactionType
*
* @param string $transaction_type
* @deprecated. Instead use setTransactionType
* @return $this
*/
public function setTransaction_type($transaction_type)
{
@@ -107,9 +132,9 @@ class PaymentDetail extends PPModel
/**
* Type of the transaction.
* @deprecated Instead use getTransactionType
*
* @return string
* @deprecated. Instead use getTransactionType
*/
public function getTransaction_type()
{
@@ -117,9 +142,11 @@ class PaymentDetail extends PPModel
}
/**
* Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
* 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).
*
* @param string $date
*
* @return $this
*/
public function setDate($date)
{
@@ -128,7 +155,7 @@ class PaymentDetail extends PPModel
}
/**
* Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
* 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).
*
* @return string
*/
@@ -137,11 +164,13 @@ class PaymentDetail extends PPModel
return $this->date;
}
/**
* Payment mode or method. This field is mandatory if the value of the type field is OTHER.
* Payment mode or method. This field is mandatory if the value of the type field is EXTERNAL.
* Valid Values: ["BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"]
*
* @param string $method
*
* @return $this
*/
public function setMethod($method)
{
@@ -150,7 +179,7 @@ class PaymentDetail extends PPModel
}
/**
* Payment mode or method. This field is mandatory if the value of the type field is OTHER.
* Payment mode or method. This field is mandatory if the value of the type field is EXTERNAL.
*
* @return string
*/
@@ -159,11 +188,12 @@ class PaymentDetail extends PPModel
return $this->method;
}
/**
* Optional note associated with the payment.
*
* @param string $note
*
* @return $this
*/
public function setNote($note)
{
@@ -181,5 +211,4 @@ class PaymentDetail extends PPModel
return $this->note;
}
}

37
lib/PayPal/Api/PaymentTerm.php
View File

@@ -1,15 +1,28 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class PaymentTerm
*
* Payment term of the invoice. If term_type is present, due_date must not be present and vice versa.
*
* @package PayPal\Api
*
* @property string term_type
* @property string due_date
*/
class PaymentTerm extends PPModel
{
/**
* Terms by which the invoice payment is due.
* Valid Values: ["DUE_ON_RECEIPT", "NET_10", "NET_15", "NET_30", "NET_45"]
*
* @param string $term_type
*
* @return $this
*/
public function setTermType($term_type)
{
@@ -30,8 +43,10 @@ class PaymentTerm extends PPModel
/**
* Terms by which the invoice payment is due.
*
* @deprecated Instead use setTermType
*
* @param string $term_type
* @deprecated. Instead use setTermType
* @return $this
*/
public function setTerm_type($term_type)
{
@@ -41,9 +56,9 @@ class PaymentTerm extends PPModel
/**
* Terms by which the invoice payment is due.
* @deprecated Instead use getTermType
*
* @return string
* @deprecated. Instead use getTermType
*/
public function getTerm_type()
{
@@ -51,9 +66,11 @@ class PaymentTerm extends PPModel
}
/**
* Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST
* 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).
*
* @param string $due_date
*
* @return $this
*/
public function setDueDate($due_date)
{
@@ -62,7 +79,7 @@ class PaymentTerm extends PPModel
}
/**
* Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST
* 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).
*
* @return string
*/
@@ -72,10 +89,12 @@ class PaymentTerm extends PPModel
}
/**
* Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST
* 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).
*
* @deprecated Instead use setDueDate
*
* @param string $due_date
* @deprecated. Instead use setDueDate
* @return $this
*/
public function setDue_date($due_date)
{
@@ -84,10 +103,10 @@ class PaymentTerm extends PPModel
}
/**
* Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST
* 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).
* @deprecated Instead use getDueDate
*
* @return string
* @deprecated. Instead use getDueDate
*/
public function getDue_date()
{

26
lib/PayPal/Api/Phone.php
View File

@@ -3,24 +3,21 @@
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* 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
*
* @property string country_code
* @property string national_number
* @property string extension
*/
class Phone extends PPModel
{
/**
* Country code (from in E.164 format)
*
* Country code (in E.164 format). Assume length is n.
*
* @param string $country_code
*
@@ -33,7 +30,7 @@ class Phone extends PPModel
}
/**
* Country code (from in E.164 format)
* Country code (in E.164 format). Assume length is n.
*
* @return string
*/
@@ -43,7 +40,7 @@ class Phone extends PPModel
}
/**
* Country code (from in E.164 format)
* Country code (in E.164 format). Assume length is n.
*
* @deprecated Instead use setCountryCode
*
@@ -57,7 +54,7 @@ class Phone extends PPModel
}
/**
* Country code (from in E.164 format)
* Country code (in E.164 format). Assume length is n.
* @deprecated Instead use getCountryCode
*
* @return string
@@ -68,8 +65,7 @@ class Phone extends PPModel
}
/**
* In-country phone number (from in E.164 format)
*
* In-country phone number (in E.164 format). Maximum (15 - n) digits.
*
* @param string $national_number
*
@@ -82,7 +78,7 @@ class Phone extends PPModel
}
/**
* In-country phone number (from in E.164 format)
* In-country phone number (in E.164 format). Maximum (15 - n) digits.
*
* @return string
*/
@@ -92,7 +88,7 @@ class Phone extends PPModel
}
/**
* In-country phone number (from in E.164 format)
* In-country phone number (in E.164 format). Maximum (15 - n) digits.
*
* @deprecated Instead use setNationalNumber
*
@@ -106,7 +102,7 @@ class Phone extends PPModel
}
/**
* In-country phone number (from in E.164 format)
* In-country phone number (in E.164 format). Maximum (15 - n) digits.
* @deprecated Instead use getNationalNumber
*
* @return string
@@ -118,10 +114,10 @@ class Phone extends PPModel
/**
* Phone extension
*
*
*
* @param string $extension
*
*
* @return $this
*/
public function setExtension($extension)

27
lib/PayPal/Api/RefundDetail.php
View File

@@ -1,15 +1,29 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class RefundDetail
*
* Invoicing refund information.
*
* @package PayPal\Api
*
* @property string type
* @property string date
* @property string note
*/
class RefundDetail extends PPModel
{
/**
* 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.
* Valid Values: ["PAYPAL", "EXTERNAL"]
*
* @param string $type
*
* @return $this
*/
public function setType($type)
{
@@ -27,11 +41,12 @@ class RefundDetail extends PPModel
return $this->type;
}
/**
* Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date.
* 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).
*
* @param string $date
*
* @return $this
*/
public function setDate($date)
{
@@ -40,7 +55,7 @@ class RefundDetail extends PPModel
}
/**
* 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 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).
*
* @return string
*/
@@ -49,11 +64,12 @@ class RefundDetail extends PPModel
return $this->date;
}
/**
* Optional note associated with the refund.
*
* @param string $note
*
* @return $this
*/
public function setNote($note)
{
@@ -71,5 +87,4 @@ class RefundDetail extends PPModel
return $this->note;
}
}

262
lib/PayPal/Api/Search.php
View File

@@ -1,15 +1,44 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class Search
*
* Invoice search parameters.
*
* @package PayPal\Api
*
* @property string email
* @property string recipient_first_name
* @property string recipient_last_name
* @property string recipient_business_name
* @property string number
* @property string status
* @property \PayPal\Api\Currency lower_total_amount
* @property \PayPal\Api\Currency upper_total_amount
* @property string start_invoice_date
* @property string end_invoice_date
* @property string start_due_date
* @property string end_due_date
* @property string start_payment_date
* @property string end_payment_date
* @property string start_creation_date
* @property string end_creation_date
* @property \PayPal\Api\number page
* @property \PayPal\Api\number page_size
* @property bool total_count_required
*/
class Search extends PPModel
{
/**
* Initial letters of the email address.
*
* @param string $email
*
* @return $this
*/
public function setEmail($email)
{
@@ -27,11 +56,12 @@ class Search extends PPModel
return $this->email;
}
/**
* Initial letters of the recipient's first name.
*
* @param string $recipient_first_name
*
* @return $this
*/
public function setRecipientFirstName($recipient_first_name)
{
@@ -52,8 +82,10 @@ class Search extends PPModel
/**
* Initial letters of the recipient's first name.
*
* @deprecated Instead use setRecipientFirstName
*
* @param string $recipient_first_name
* @deprecated. Instead use setRecipientFirstName
* @return $this
*/
public function setRecipient_first_name($recipient_first_name)
{
@@ -63,9 +95,9 @@ class Search extends PPModel
/**
* Initial letters of the recipient's first name.
* @deprecated Instead use getRecipientFirstName
*
* @return string
* @deprecated. Instead use getRecipientFirstName
*/
public function getRecipient_first_name()
{
@@ -76,6 +108,8 @@ class Search extends PPModel
* Initial letters of the recipient's last name.
*
* @param string $recipient_last_name
*
* @return $this
*/
public function setRecipientLastName($recipient_last_name)
{
@@ -96,8 +130,10 @@ class Search extends PPModel
/**
* Initial letters of the recipient's last name.
*
* @deprecated Instead use setRecipientLastName
*
* @param string $recipient_last_name
* @deprecated. Instead use setRecipientLastName
* @return $this
*/
public function setRecipient_last_name($recipient_last_name)
{
@@ -107,9 +143,9 @@ class Search extends PPModel
/**
* Initial letters of the recipient's last name.
* @deprecated Instead use getRecipientLastName
*
* @return string
* @deprecated. Instead use getRecipientLastName
*/
public function getRecipient_last_name()
{
@@ -120,6 +156,8 @@ class Search extends PPModel
* Initial letters of the recipient's business name.
*
* @param string $recipient_business_name
*
* @return $this
*/
public function setRecipientBusinessName($recipient_business_name)
{
@@ -140,8 +178,10 @@ class Search extends PPModel
/**
* Initial letters of the recipient's business name.
*
* @deprecated Instead use setRecipientBusinessName
*
* @param string $recipient_business_name
* @deprecated. Instead use setRecipientBusinessName
* @return $this
*/
public function setRecipient_business_name($recipient_business_name)
{
@@ -151,9 +191,9 @@ class Search extends PPModel
/**
* Initial letters of the recipient's business name.
* @deprecated Instead use getRecipientBusinessName
*
* @return string
* @deprecated. Instead use getRecipientBusinessName
*/
public function getRecipient_business_name()
{
@@ -164,6 +204,8 @@ class Search extends PPModel
* The invoice number that appears on the invoice.
*
* @param string $number
*
* @return $this
*/
public function setNumber($number)
{
@@ -181,11 +223,13 @@ class Search extends PPModel
return $this->number;
}
/**
* 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)
{
@@ -203,11 +247,12 @@ class Search extends PPModel
return $this->status;
}
/**
* Lower limit of total amount.
*
* @param PayPal\Api\Currency $lower_total_amount
* @param \PayPal\Api\Currency $lower_total_amount
*
* @return $this
*/
public function setLowerTotalAmount($lower_total_amount)
{
@@ -218,7 +263,7 @@ class Search extends PPModel
/**
* Lower limit of total amount.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getLowerTotalAmount()
{
@@ -228,8 +273,10 @@ class Search extends PPModel
/**
* Lower limit of total amount.
*
* @param PayPal\Api\Currency $lower_total_amount
* @deprecated. Instead use setLowerTotalAmount
* @deprecated Instead use setLowerTotalAmount
*
* @param \PayPal\Api\Currency $lower_total_amount
* @return $this
*/
public function setLower_total_amount($lower_total_amount)
{
@@ -239,9 +286,9 @@ class Search extends PPModel
/**
* Lower limit of total amount.
* @deprecated Instead use getLowerTotalAmount
*
* @return PayPal\Api\Currency
* @deprecated. Instead use getLowerTotalAmount
* @return \PayPal\Api\Currency
*/
public function getLower_total_amount()
{
@@ -251,7 +298,9 @@ class Search extends PPModel
/**
* Upper limit of total amount.
*
* @param PayPal\Api\Currency $upper_total_amount
* @param \PayPal\Api\Currency $upper_total_amount
*
* @return $this
*/
public function setUpperTotalAmount($upper_total_amount)
{
@@ -262,7 +311,7 @@ class Search extends PPModel
/**
* Upper limit of total amount.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getUpperTotalAmount()
{
@@ -272,8 +321,10 @@ class Search extends PPModel
/**
* Upper limit of total amount.
*
* @param PayPal\Api\Currency $upper_total_amount
* @deprecated. Instead use setUpperTotalAmount
* @deprecated Instead use setUpperTotalAmount
*
* @param \PayPal\Api\Currency $upper_total_amount
* @return $this
*/
public function setUpper_total_amount($upper_total_amount)
{
@@ -283,9 +334,9 @@ class Search extends PPModel
/**
* Upper limit of total amount.
* @deprecated Instead use getUpperTotalAmount
*
* @return PayPal\Api\Currency
* @deprecated. Instead use getUpperTotalAmount
* @return \PayPal\Api\Currency
*/
public function getUpper_total_amount()
{
@@ -293,9 +344,11 @@ class Search extends PPModel
}
/**
* 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).
*
* @param string $start_invoice_date
*
* @return $this
*/
public function setStartInvoiceDate($start_invoice_date)
{
@@ -304,7 +357,7 @@ class Search extends PPModel
}
/**
* 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).
*
* @return string
*/
@@ -314,10 +367,12 @@ class Search extends PPModel
}
/**
* 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).
*
* @deprecated Instead use setStartInvoiceDate
*
* @param string $start_invoice_date
* @deprecated. Instead use setStartInvoiceDate
* @return $this
*/
public function setStart_invoice_date($start_invoice_date)
{
@@ -326,10 +381,10 @@ class Search extends PPModel
}
/**
* 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).
* @deprecated Instead use getStartInvoiceDate
*
* @return string
* @deprecated. Instead use getStartInvoiceDate
*/
public function getStart_invoice_date()
{
@@ -337,9 +392,11 @@ class Search extends PPModel
}
/**
* 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).
*
* @param string $end_invoice_date
*
* @return $this
*/
public function setEndInvoiceDate($end_invoice_date)
{
@@ -348,7 +405,7 @@ class Search extends PPModel
}
/**
* 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).
*
* @return string
*/
@@ -358,10 +415,12 @@ class Search extends PPModel
}
/**
* 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).
*
* @deprecated Instead use setEndInvoiceDate
*
* @param string $end_invoice_date
* @deprecated. Instead use setEndInvoiceDate
* @return $this
*/
public function setEnd_invoice_date($end_invoice_date)
{
@@ -370,10 +429,10 @@ class Search extends PPModel
}
/**
* 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).
* @deprecated Instead use getEndInvoiceDate
*
* @return string
* @deprecated. Instead use getEndInvoiceDate
*/
public function getEnd_invoice_date()
{
@@ -381,9 +440,11 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @param string $start_due_date
*
* @return $this
*/
public function setStartDueDate($start_due_date)
{
@@ -392,7 +453,7 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @return string
*/
@@ -402,10 +463,12 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @deprecated Instead use setStartDueDate
*
* @param string $start_due_date
* @deprecated. Instead use setStartDueDate
* @return $this
*/
public function setStart_due_date($start_due_date)
{
@@ -414,10 +477,10 @@ class Search extends PPModel
}
/**
* Start invoice 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).
* @deprecated Instead use getStartDueDate
*
* @return string
* @deprecated. Instead use getStartDueDate
*/
public function getStart_due_date()
{
@@ -425,9 +488,11 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @param string $end_due_date
*
* @return $this
*/
public function setEndDueDate($end_due_date)
{
@@ -436,7 +501,7 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @return string
*/
@@ -446,10 +511,12 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @deprecated Instead use setEndDueDate
*
* @param string $end_due_date
* @deprecated. Instead use setEndDueDate
* @return $this
*/
public function setEnd_due_date($end_due_date)
{
@@ -458,10 +525,10 @@ class Search extends PPModel
}
/**
* End invoice 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).
* @deprecated Instead use getEndDueDate
*
* @return string
* @deprecated. Instead use getEndDueDate
*/
public function getEnd_due_date()
{
@@ -469,9 +536,11 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @param string $start_payment_date
*
* @return $this
*/
public function setStartPaymentDate($start_payment_date)
{
@@ -480,7 +549,7 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @return string
*/
@@ -490,10 +559,12 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @deprecated Instead use setStartPaymentDate
*
* @param string $start_payment_date
* @deprecated. Instead use setStartPaymentDate
* @return $this
*/
public function setStart_payment_date($start_payment_date)
{
@@ -502,10 +573,10 @@ class Search extends PPModel
}
/**
* Start invoice 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).
* @deprecated Instead use getStartPaymentDate
*
* @return string
* @deprecated. Instead use getStartPaymentDate
*/
public function getStart_payment_date()
{
@@ -513,9 +584,11 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @param string $end_payment_date
*
* @return $this
*/
public function setEndPaymentDate($end_payment_date)
{
@@ -524,7 +597,7 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @return string
*/
@@ -534,10 +607,12 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @deprecated Instead use setEndPaymentDate
*
* @param string $end_payment_date
* @deprecated. Instead use setEndPaymentDate
* @return $this
*/
public function setEnd_payment_date($end_payment_date)
{
@@ -546,10 +621,10 @@ class Search extends PPModel
}
/**
* End invoice 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).
* @deprecated Instead use getEndPaymentDate
*
* @return string
* @deprecated. Instead use getEndPaymentDate
*/
public function getEnd_payment_date()
{
@@ -557,9 +632,11 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @param string $start_creation_date
*
* @return $this
*/
public function setStartCreationDate($start_creation_date)
{
@@ -568,7 +645,7 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @return string
*/
@@ -578,10 +655,12 @@ class Search extends PPModel
}
/**
* Start invoice 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).
*
* @deprecated Instead use setStartCreationDate
*
* @param string $start_creation_date
* @deprecated. Instead use setStartCreationDate
* @return $this
*/
public function setStart_creation_date($start_creation_date)
{
@@ -590,10 +669,10 @@ class Search extends PPModel
}
/**
* Start invoice 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).
* @deprecated Instead use getStartCreationDate
*
* @return string
* @deprecated. Instead use getStartCreationDate
*/
public function getStart_creation_date()
{
@@ -601,9 +680,11 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @param string $end_creation_date
*
* @return $this
*/
public function setEndCreationDate($end_creation_date)
{
@@ -612,7 +693,7 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @return string
*/
@@ -622,10 +703,12 @@ class Search extends PPModel
}
/**
* End invoice 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).
*
* @deprecated Instead use setEndCreationDate
*
* @param string $end_creation_date
* @deprecated. Instead use setEndCreationDate
* @return $this
*/
public function setEnd_creation_date($end_creation_date)
{
@@ -634,10 +717,10 @@ class Search extends PPModel
}
/**
* End invoice 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).
* @deprecated Instead use getEndCreationDate
*
* @return string
* @deprecated. Instead use getEndCreationDate
*/
public function getEnd_creation_date()
{
@@ -647,7 +730,9 @@ class Search extends PPModel
/**
* Offset of the search results.
*
* @param PayPal\Api\number $page
* @param \PayPal\Api\number $page
*
* @return $this
*/
public function setPage($page)
{
@@ -658,18 +743,19 @@ class Search extends PPModel
/**
* Offset of the search results.
*
* @return PayPal\Api\number
* @return \PayPal\Api\number
*/
public function getPage()
{
return $this->page;
}
/**
* Page size of the search results.
*
* @param PayPal\Api\number $page_size
* @param \PayPal\Api\number $page_size
*
* @return $this
*/
public function setPageSize($page_size)
{
@@ -680,7 +766,7 @@ class Search extends PPModel
/**
* Page size of the search results.
*
* @return PayPal\Api\number
* @return \PayPal\Api\number
*/
public function getPageSize()
{
@@ -690,8 +776,10 @@ class Search extends PPModel
/**
* Page size of the search results.
*
* @param PayPal\Api\number $page_size
* @deprecated. Instead use setPageSize
* @deprecated Instead use setPageSize
*
* @param \PayPal\Api\number $page_size
* @return $this
*/
public function setPage_size($page_size)
{
@@ -701,9 +789,9 @@ class Search extends PPModel
/**
* Page size of the search results.
* @deprecated Instead use getPageSize
*
* @return PayPal\Api\number
* @deprecated. Instead use getPageSize
* @return \PayPal\Api\number
*/
public function getPage_size()
{
@@ -713,7 +801,9 @@ class Search extends PPModel
/**
* A flag indicating whether total count is required in the response.
*
* @param boolean $total_count_required
* @param bool $total_count_required
*
* @return $this
*/
public function setTotalCountRequired($total_count_required)
{
@@ -724,7 +814,7 @@ class Search extends PPModel
/**
* A flag indicating whether total count is required in the response.
*
* @return boolean
* @return bool
*/
public function getTotalCountRequired()
{
@@ -734,8 +824,10 @@ class Search extends PPModel
/**
* A flag indicating whether total count is required in the response.
*
* @param boolean $total_count_required
* @deprecated. Instead use setTotalCountRequired
* @deprecated Instead use setTotalCountRequired
*
* @param bool $total_count_required
* @return $this
*/
public function setTotal_count_required($total_count_required)
{
@@ -745,9 +837,9 @@ class Search extends PPModel
/**
* A flag indicating whether total count is required in the response.
* @deprecated Instead use getTotalCountRequired
*
* @return boolean
* @deprecated. Instead use getTotalCountRequired
* @return bool
*/
public function getTotal_count_required()
{

26
lib/PayPal/Api/ShippingCost.php
View File

@@ -1,15 +1,27 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class ShippingCost
*
* Shipping cost in percent or amount.
*
* @package PayPal\Api
*
* @property \PayPal\Api\Currency amount
* @property \PayPal\Api\Tax tax
*/
class ShippingCost extends PPModel
{
/**
* Shipping cost in amount. Range of 0 to 999999.99.
*
* @param PayPal\Api\Currency $amount
* @param \PayPal\Api\Currency $amount
*
* @return $this
*/
public function setAmount($amount)
{
@@ -20,18 +32,19 @@ class ShippingCost extends PPModel
/**
* Shipping cost in amount. Range of 0 to 999999.99.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getAmount()
{
return $this->amount;
}
/**
* Tax percentage on shipping amount.
*
* @param PayPal\Api\Tax $tax
* @param \PayPal\Api\Tax $tax
*
* @return $this
*/
public function setTax($tax)
{
@@ -42,12 +55,11 @@ class ShippingCost extends PPModel
/**
* Tax percentage on shipping amount.
*
* @return PayPal\Api\Tax
* @return \PayPal\Api\Tax
*/
public function getTax()
{
return $this->tax;
}
}

50
lib/PayPal/Api/ShippingInfo.php
View File

@@ -1,15 +1,29 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class ShippingInfo
*
* Shipping information for the invoice recipient.
*
* @package PayPal\Api
*
* @property string first_name
* @property string last_name
* @property string business_name
* @property \PayPal\Api\Address address
*/
class ShippingInfo extends PPModel
{
/**
* First name of the invoice recipient. 30 characters max.
*
* @param string $first_name
*
* @return $this
*/
public function setFirstName($first_name)
{
@@ -30,8 +44,10 @@ class ShippingInfo extends PPModel
/**
* First name of the invoice recipient. 30 characters max.
*
* @deprecated Instead use setFirstName
*
* @param string $first_name
* @deprecated. Instead use setFirstName
* @return $this
*/
public function setFirst_name($first_name)
{
@@ -41,9 +57,9 @@ class ShippingInfo extends PPModel
/**
* First name of the invoice recipient. 30 characters max.
* @deprecated Instead use getFirstName
*
* @return string
* @deprecated. Instead use getFirstName
*/
public function getFirst_name()
{
@@ -54,6 +70,8 @@ class ShippingInfo extends PPModel
* Last name of the invoice recipient. 30 characters max.
*
* @param string $last_name
*
* @return $this
*/
public function setLastName($last_name)
{
@@ -74,8 +92,10 @@ class ShippingInfo extends PPModel
/**
* Last name of the invoice recipient. 30 characters max.
*
* @deprecated Instead use setLastName
*
* @param string $last_name
* @deprecated. Instead use setLastName
* @return $this
*/
public function setLast_name($last_name)
{
@@ -85,9 +105,9 @@ class ShippingInfo extends PPModel
/**
* Last name of the invoice recipient. 30 characters max.
* @deprecated Instead use getLastName
*
* @return string
* @deprecated. Instead use getLastName
*/
public function getLast_name()
{
@@ -98,6 +118,8 @@ class ShippingInfo extends PPModel
* Company business name of the invoice recipient. 100 characters max.
*
* @param string $business_name
*
* @return $this
*/
public function setBusinessName($business_name)
{
@@ -118,8 +140,10 @@ class ShippingInfo extends PPModel
/**
* Company business name of the invoice recipient. 100 characters max.
*
* @deprecated Instead use setBusinessName
*
* @param string $business_name
* @deprecated. Instead use setBusinessName
* @return $this
*/
public function setBusiness_name($business_name)
{
@@ -129,9 +153,9 @@ class ShippingInfo extends PPModel
/**
* Company business name of the invoice recipient. 100 characters max.
* @deprecated Instead use getBusinessName
*
* @return string
* @deprecated. Instead use getBusinessName
*/
public function getBusiness_name()
{
@@ -141,7 +165,7 @@ class ShippingInfo extends PPModel
/**
*
*
* @param PayPal\Api\Phone $phone
* @param \PayPal\Api\Phone $phone
*/
public function setPhone($phone)
{
@@ -152,18 +176,19 @@ class ShippingInfo extends PPModel
/**
*
*
* @return PayPal\Api\Phone
* @return \PayPal\Api\Phone
*/
public function getPhone()
{
return $this->phone;
}
/**
* Address of the invoice recipient.
*
* @param PayPal\Api\Address $address
* @param \PayPal\Api\Address $address
*
* @return $this
*/
public function setAddress($address)
{
@@ -174,12 +199,11 @@ class ShippingInfo extends PPModel
/**
* Address of the invoice recipient.
*
* @return PayPal\Api\Address
* @return \PayPal\Api\Address
*/
public function getAddress()
{
return $this->address;
}
}

34
lib/PayPal/Api/Tax.php
View File

@@ -1,15 +1,29 @@
<?php
namespace PayPal\Api;
use PayPal\Common\PPModel;
use PayPal\Rest\ApiContext;
/**
* Class Tax
*
* Tax information.
*
* @package PayPal\Api
*
* @property string id
* @property string name
* @property \PayPal\Api\number percent
* @property \PayPal\Api\Currency amount
*/
class Tax extends PPModel
{
/**
* Identifier of the resource.
*
* @param string $id
*
* @return $this
*/
public function setId($id)
{
@@ -27,11 +41,12 @@ class Tax extends PPModel
return $this->id;
}
/**
* Name of the tax. 10 characters max.
*
* @param string $name
*
* @return $this
*/
public function setName($name)
{
@@ -49,11 +64,12 @@ class Tax extends PPModel
return $this->name;
}
/**
* Rate of the specified tax. Range of 0.001 to 99.999.
*
* @param PayPal\Api\number $percent
* @param \PayPal\Api\number $percent
*
* @return $this
*/
public function setPercent($percent)
{
@@ -64,18 +80,19 @@ class Tax extends PPModel
/**
* Rate of the specified tax. Range of 0.001 to 99.999.
*
* @return PayPal\Api\number
* @return \PayPal\Api\number
*/
public function getPercent()
{
return $this->percent;
}
/**
* Tax in the form of money. Cannot be specified in a request.
*
* @param PayPal\Api\Currency $amount
* @param \PayPal\Api\Currency $amount
*
* @return $this
*/
public function setAmount($amount)
{
@@ -86,12 +103,11 @@ class Tax extends PPModel
/**
* Tax in the form of money. Cannot be specified in a request.
*
* @return PayPal\Api\Currency
* @return \PayPal\Api\Currency
*/
public function getAmount()
{
return $this->amount;
}
}