CardholderService.php 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Service\Issuing;
  4. class CardholderService extends \Stripe\Service\AbstractService
  5. {
  6. /**
  7. * Returns a list of Issuing <code>Cardholder</code> objects. The objects are
  8. * sorted in descending order by creation date, with the most recently created
  9. * object appearing first.
  10. *
  11. * @param null|array $params
  12. * @param null|array|\Stripe\Util\RequestOptions $opts
  13. *
  14. * @throws \Stripe\Exception\ApiErrorException if the request fails
  15. *
  16. * @return \Stripe\Collection
  17. */
  18. public function all($params = null, $opts = null)
  19. {
  20. return $this->requestCollection('get', '/v1/issuing/cardholders', $params, $opts);
  21. }
  22. /**
  23. * Creates a new Issuing <code>Cardholder</code> object that can be issued cards.
  24. *
  25. * @param null|array $params
  26. * @param null|array|\Stripe\Util\RequestOptions $opts
  27. *
  28. * @throws \Stripe\Exception\ApiErrorException if the request fails
  29. *
  30. * @return \Stripe\Issuing\Cardholder
  31. */
  32. public function create($params = null, $opts = null)
  33. {
  34. return $this->request('post', '/v1/issuing/cardholders', $params, $opts);
  35. }
  36. /**
  37. * Retrieves an Issuing <code>Cardholder</code> object.
  38. *
  39. * @param string $id
  40. * @param null|array $params
  41. * @param null|array|\Stripe\Util\RequestOptions $opts
  42. *
  43. * @throws \Stripe\Exception\ApiErrorException if the request fails
  44. *
  45. * @return \Stripe\Issuing\Cardholder
  46. */
  47. public function retrieve($id, $params = null, $opts = null)
  48. {
  49. return $this->request('get', $this->buildPath('/v1/issuing/cardholders/%s', $id), $params, $opts);
  50. }
  51. /**
  52. * Updates the specified Issuing <code>Cardholder</code> object by setting the
  53. * values of the parameters passed. Any parameters not provided will be left
  54. * unchanged.
  55. *
  56. * @param string $id
  57. * @param null|array $params
  58. * @param null|array|\Stripe\Util\RequestOptions $opts
  59. *
  60. * @throws \Stripe\Exception\ApiErrorException if the request fails
  61. *
  62. * @return \Stripe\Issuing\Cardholder
  63. */
  64. public function update($id, $params = null, $opts = null)
  65. {
  66. return $this->request('post', $this->buildPath('/v1/issuing/cardholders/%s', $id), $params, $opts);
  67. }
  68. }