PayPalApiSearch

Class Search.

Defined (1)

The class is defined in the following location(s).

/classes/lib/PayPal/Api/Search.php  
  1. class Search extends PayPalModel 
  2. /** 
  3. * Initial letters of the email address. 
  4. * @param string $email 
  5. *  
  6. * @return $this 
  7. */ 
  8. public function setEmail($email) 
  9. $this->email = $email; 
  10. return $this; 
  11.  
  12. /** 
  13. * Initial letters of the email address. 
  14. * @return string 
  15. */ 
  16. public function getEmail() 
  17. return $this->email; 
  18.  
  19. /** 
  20. * Initial letters of the recipient's first name. 
  21. * @param string $recipient_first_name 
  22. *  
  23. * @return $this 
  24. */ 
  25. public function setRecipientFirstName($recipient_first_name) 
  26. $this->recipient_first_name = $recipient_first_name; 
  27. return $this; 
  28.  
  29. /** 
  30. * Initial letters of the recipient's first name. 
  31. * @return string 
  32. */ 
  33. public function getRecipientFirstName() 
  34. return $this->recipient_first_name; 
  35.  
  36. /** 
  37. * Initial letters of the recipient's last name. 
  38. * @param string $recipient_last_name 
  39. *  
  40. * @return $this 
  41. */ 
  42. public function setRecipientLastName($recipient_last_name) 
  43. $this->recipient_last_name = $recipient_last_name; 
  44. return $this; 
  45.  
  46. /** 
  47. * Initial letters of the recipient's last name. 
  48. * @return string 
  49. */ 
  50. public function getRecipientLastName() 
  51. return $this->recipient_last_name; 
  52.  
  53. /** 
  54. * Initial letters of the recipient's business name. 
  55. * @param string $recipient_business_name 
  56. *  
  57. * @return $this 
  58. */ 
  59. public function setRecipientBusinessName($recipient_business_name) 
  60. $this->recipient_business_name = $recipient_business_name; 
  61. return $this; 
  62.  
  63. /** 
  64. * Initial letters of the recipient's business name. 
  65. * @return string 
  66. */ 
  67. public function getRecipientBusinessName() 
  68. return $this->recipient_business_name; 
  69.  
  70. /** 
  71. * The invoice number that appears on the invoice. 
  72. * @param string $number 
  73. *  
  74. * @return $this 
  75. */ 
  76. public function setNumber($number) 
  77. $this->number = $number; 
  78. return $this; 
  79.  
  80. /** 
  81. * The invoice number that appears on the invoice. 
  82. * @return string 
  83. */ 
  84. public function getNumber() 
  85. return $this->number; 
  86.  
  87. /** 
  88. * Status of the invoice. 
  89. * Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"] 
  90. * @param string $status 
  91. *  
  92. * @return $this 
  93. */ 
  94. public function setStatus($status) 
  95. $this->status = $status; 
  96. return $this; 
  97.  
  98. /** 
  99. * Status of the invoice. 
  100. * @return string 
  101. */ 
  102. public function getStatus() 
  103. return $this->status; 
  104.  
  105. /** 
  106. * Lower limit of total amount. 
  107. * @param \PayPal\Api\Currency $lower_total_amount 
  108. *  
  109. * @return $this 
  110. */ 
  111. public function setLowerTotalAmount($lower_total_amount) 
  112. $this->lower_total_amount = $lower_total_amount; 
  113. return $this; 
  114.  
  115. /** 
  116. * Lower limit of total amount. 
  117. * @return \PayPal\Api\Currency 
  118. */ 
  119. public function getLowerTotalAmount() 
  120. return $this->lower_total_amount; 
  121.  
  122. /** 
  123. * Upper limit of total amount. 
  124. * @param \PayPal\Api\Currency $upper_total_amount 
  125. *  
  126. * @return $this 
  127. */ 
  128. public function setUpperTotalAmount($upper_total_amount) 
  129. $this->upper_total_amount = $upper_total_amount; 
  130. return $this; 
  131.  
  132. /** 
  133. * Upper limit of total amount. 
  134. * @return \PayPal\Api\Currency 
  135. */ 
  136. public function getUpperTotalAmount() 
  137. return $this->upper_total_amount; 
  138.  
  139. /** 
  140. * Start invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  141. * @param string $start_invoice_date 
  142. *  
  143. * @return $this 
  144. */ 
  145. public function setStartInvoiceDate($start_invoice_date) 
  146. $this->start_invoice_date = $start_invoice_date; 
  147. return $this; 
  148.  
  149. /** 
  150. * Start invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  151. * @return string 
  152. */ 
  153. public function getStartInvoiceDate() 
  154. return $this->start_invoice_date; 
  155.  
  156. /** 
  157. * End invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  158. * @param string $end_invoice_date 
  159. *  
  160. * @return $this 
  161. */ 
  162. public function setEndInvoiceDate($end_invoice_date) 
  163. $this->end_invoice_date = $end_invoice_date; 
  164. return $this; 
  165.  
  166. /** 
  167. * End invoice date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  168. * @return string 
  169. */ 
  170. public function getEndInvoiceDate() 
  171. return $this->end_invoice_date; 
  172.  
  173. /** 
  174. * Start invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  175. * @param string $start_due_date 
  176. *  
  177. * @return $this 
  178. */ 
  179. public function setStartDueDate($start_due_date) 
  180. $this->start_due_date = $start_due_date; 
  181. return $this; 
  182.  
  183. /** 
  184. * Start invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  185. * @return string 
  186. */ 
  187. public function getStartDueDate() 
  188. return $this->start_due_date; 
  189.  
  190. /** 
  191. * End invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  192. * @param string $end_due_date 
  193. *  
  194. * @return $this 
  195. */ 
  196. public function setEndDueDate($end_due_date) 
  197. $this->end_due_date = $end_due_date; 
  198. return $this; 
  199.  
  200. /** 
  201. * End invoice due date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  202. * @return string 
  203. */ 
  204. public function getEndDueDate() 
  205. return $this->end_due_date; 
  206.  
  207. /** 
  208. * Start invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  209. * @param string $start_payment_date 
  210. *  
  211. * @return $this 
  212. */ 
  213. public function setStartPaymentDate($start_payment_date) 
  214. $this->start_payment_date = $start_payment_date; 
  215. return $this; 
  216.  
  217. /** 
  218. * Start invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  219. * @return string 
  220. */ 
  221. public function getStartPaymentDate() 
  222. return $this->start_payment_date; 
  223.  
  224. /** 
  225. * End invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  226. * @param string $end_payment_date 
  227. *  
  228. * @return $this 
  229. */ 
  230. public function setEndPaymentDate($end_payment_date) 
  231. $this->end_payment_date = $end_payment_date; 
  232. return $this; 
  233.  
  234. /** 
  235. * End invoice payment date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  236. * @return string 
  237. */ 
  238. public function getEndPaymentDate() 
  239. return $this->end_payment_date; 
  240.  
  241. /** 
  242. * Start invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  243. * @param string $start_creation_date 
  244. *  
  245. * @return $this 
  246. */ 
  247. public function setStartCreationDate($start_creation_date) 
  248. $this->start_creation_date = $start_creation_date; 
  249. return $this; 
  250.  
  251. /** 
  252. * Start invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  253. * @return string 
  254. */ 
  255. public function getStartCreationDate() 
  256. return $this->start_creation_date; 
  257.  
  258. /** 
  259. * End invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  260. * @param string $end_creation_date 
  261. *  
  262. * @return $this 
  263. */ 
  264. public function setEndCreationDate($end_creation_date) 
  265. $this->end_creation_date = $end_creation_date; 
  266. return $this; 
  267.  
  268. /** 
  269. * End invoice creation date. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). 
  270. * @return string 
  271. */ 
  272. public function getEndCreationDate() 
  273. return $this->end_creation_date; 
  274.  
  275. /** 
  276. * Offset of the search results. 
  277. * @param \PayPal\Api\number $page 
  278. *  
  279. * @return $this 
  280. */ 
  281. public function setPage($page) 
  282. $this->page = $page; 
  283. return $this; 
  284.  
  285. /** 
  286. * Offset of the search results. 
  287. * @return \PayPal\Api\number 
  288. */ 
  289. public function getPage() 
  290. return $this->page; 
  291.  
  292. /** 
  293. * Page size of the search results. 
  294. * @param \PayPal\Api\number $page_size 
  295. *  
  296. * @return $this 
  297. */ 
  298. public function setPageSize($page_size) 
  299. $this->page_size = $page_size; 
  300. return $this; 
  301.  
  302. /** 
  303. * Page size of the search results. 
  304. * @return \PayPal\Api\number 
  305. */ 
  306. public function getPageSize() 
  307. return $this->page_size; 
  308.  
  309. /** 
  310. * A flag indicating whether total count is required in the response. 
  311. * @param bool $total_count_required 
  312. *  
  313. * @return $this 
  314. */ 
  315. public function setTotalCountRequired($total_count_required) 
  316. $this->total_count_required = $total_count_required; 
  317. return $this; 
  318.  
  319. /** 
  320. * A flag indicating whether total count is required in the response. 
  321. * @return bool 
  322. */ 
  323. public function getTotalCountRequired() 
  324. return $this->total_count_required; 
  325.