EventService.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Service;
  4. /**
  5. * @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  6. * @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  7. */
  8. class EventService extends \Stripe\Service\AbstractService
  9. {
  10. /**
  11. * List events, going back up to 30 days. Each event data is rendered according to
  12. * Stripe API version at its creation time, specified in <a
  13. * href="https://docs.stripe.com/api/events/object">event object</a>
  14. * <code>api_version</code> attribute (not according to your current Stripe API
  15. * version or <code>Stripe-Version</code> header).
  16. *
  17. * @param null|array $params
  18. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  19. *
  20. * @throws \Stripe\Exception\ApiErrorException if the request fails
  21. *
  22. * @return \Stripe\Collection<\Stripe\Event>
  23. */
  24. public function all($params = null, $opts = null)
  25. {
  26. return $this->requestCollection('get', '/v1/events', $params, $opts);
  27. }
  28. /**
  29. * Retrieves the details of an event. Supply the unique identifier of the event,
  30. * which you might have received in a webhook.
  31. *
  32. * @param string $id
  33. * @param null|array $params
  34. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  35. *
  36. * @throws \Stripe\Exception\ApiErrorException if the request fails
  37. *
  38. * @return \Stripe\Event
  39. */
  40. public function retrieve($id, $params = null, $opts = null)
  41. {
  42. return $this->request('get', $this->buildPath('/v1/events/%s', $id), $params, $opts);
  43. }
  44. }