Recipient.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. <?php
  2. namespace Stripe;
  3. /**
  4. * Class Recipient
  5. *
  6. * @package Stripe
  7. */
  8. class Recipient extends ApiResource
  9. {
  10. /**
  11. * @param string $id The ID of the recipient to retrieve.
  12. * @param array|string|null $opts
  13. *
  14. * @return Recipient
  15. */
  16. public static function retrieve($id, $opts = null)
  17. {
  18. return self::_retrieve($id, $opts);
  19. }
  20. /**
  21. * @param array|null $params
  22. * @param array|string|null $opts
  23. *
  24. * @return Collection of Recipients
  25. */
  26. public static function all($params = null, $opts = null)
  27. {
  28. return self::_all($params, $opts);
  29. }
  30. /**
  31. * @param array|null $params
  32. * @param array|string|null $opts
  33. *
  34. * @return Recipient The created recipient.
  35. */
  36. public static function create($params = null, $opts = null)
  37. {
  38. return self::_create($params, $opts);
  39. }
  40. /**
  41. * @param string $id The ID of the recipient to update.
  42. * @param array|null $params
  43. * @param array|string|null $options
  44. *
  45. * @return Recipient The updated recipient.
  46. */
  47. public static function update($id, $params = null, $options = null)
  48. {
  49. return self::_update($id, $params, $options);
  50. }
  51. /**
  52. * @param array|string|null $opts
  53. *
  54. * @return Recipient The saved recipient.
  55. */
  56. public function save($opts = null)
  57. {
  58. return $this->_save($opts);
  59. }
  60. /**
  61. * @param array|null $params
  62. *
  63. * @return Recipient The deleted recipient.
  64. */
  65. public function delete($params = null, $opts = null)
  66. {
  67. return $this->_delete($params, $opts);
  68. }
  69. /**
  70. * @param array|null $params
  71. *
  72. * @return Collection of the Recipient's Transfers
  73. */
  74. public function transfers($params = null)
  75. {
  76. if ($params === null) {
  77. $params = array();
  78. }
  79. $params['recipient'] = $this->id;
  80. $transfers = Transfer::all($params, $this->_opts);
  81. return $transfers;
  82. }
  83. }