TransactionService.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Service\Tax;
  4. /**
  5. * @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  6. * @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  7. */
  8. class TransactionService extends \Stripe\Service\AbstractService
  9. {
  10. /**
  11. * Retrieves the line items of a committed standalone transaction as a collection.
  12. *
  13. * @param string $id
  14. * @param null|array $params
  15. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  16. *
  17. * @throws \Stripe\Exception\ApiErrorException if the request fails
  18. *
  19. * @return \Stripe\Collection<\Stripe\Tax\TransactionLineItem>
  20. */
  21. public function allLineItems($id, $params = null, $opts = null)
  22. {
  23. return $this->requestCollection('get', $this->buildPath('/v1/tax/transactions/%s/line_items', $id), $params, $opts);
  24. }
  25. /**
  26. * Creates a Tax Transaction from a calculation, if that calculation hasn’t
  27. * expired. Calculations expire after 90 days.
  28. *
  29. * @param null|array $params
  30. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  31. *
  32. * @throws \Stripe\Exception\ApiErrorException if the request fails
  33. *
  34. * @return \Stripe\Tax\Transaction
  35. */
  36. public function createFromCalculation($params = null, $opts = null)
  37. {
  38. return $this->request('post', '/v1/tax/transactions/create_from_calculation', $params, $opts);
  39. }
  40. /**
  41. * Partially or fully reverses a previously created <code>Transaction</code>.
  42. *
  43. * @param null|array $params
  44. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  45. *
  46. * @throws \Stripe\Exception\ApiErrorException if the request fails
  47. *
  48. * @return \Stripe\Tax\Transaction
  49. */
  50. public function createReversal($params = null, $opts = null)
  51. {
  52. return $this->request('post', '/v1/tax/transactions/create_reversal', $params, $opts);
  53. }
  54. /**
  55. * Retrieves a Tax <code>Transaction</code> object.
  56. *
  57. * @param string $id
  58. * @param null|array $params
  59. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  60. *
  61. * @throws \Stripe\Exception\ApiErrorException if the request fails
  62. *
  63. * @return \Stripe\Tax\Transaction
  64. */
  65. public function retrieve($id, $params = null, $opts = null)
  66. {
  67. return $this->request('get', $this->buildPath('/v1/tax/transactions/%s', $id), $params, $opts);
  68. }
  69. }