AccountService.php 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Service\FinancialConnections;
  4. /**
  5. * @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  6. * @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  7. */
  8. class AccountService extends \Stripe\Service\AbstractService
  9. {
  10. /**
  11. * Returns a list of Financial Connections <code>Account</code> objects.
  12. *
  13. * @param null|array $params
  14. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  15. *
  16. * @throws \Stripe\Exception\ApiErrorException if the request fails
  17. *
  18. * @return \Stripe\Collection<\Stripe\FinancialConnections\Account>
  19. */
  20. public function all($params = null, $opts = null)
  21. {
  22. return $this->requestCollection('get', '/v1/financial_connections/accounts', $params, $opts);
  23. }
  24. /**
  25. * Lists all owners for a given <code>Account</code>.
  26. *
  27. * @param string $id
  28. * @param null|array $params
  29. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  30. *
  31. * @throws \Stripe\Exception\ApiErrorException if the request fails
  32. *
  33. * @return \Stripe\Collection<\Stripe\FinancialConnections\AccountOwner>
  34. */
  35. public function allOwners($id, $params = null, $opts = null)
  36. {
  37. return $this->requestCollection('get', $this->buildPath('/v1/financial_connections/accounts/%s/owners', $id), $params, $opts);
  38. }
  39. /**
  40. * Disables your access to a Financial Connections <code>Account</code>. You will
  41. * no longer be able to access data associated with the account (e.g. balances,
  42. * transactions).
  43. *
  44. * @param string $id
  45. * @param null|array $params
  46. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  47. *
  48. * @throws \Stripe\Exception\ApiErrorException if the request fails
  49. *
  50. * @return \Stripe\FinancialConnections\Account
  51. */
  52. public function disconnect($id, $params = null, $opts = null)
  53. {
  54. return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/disconnect', $id), $params, $opts);
  55. }
  56. /**
  57. * Refreshes the data associated with a Financial Connections <code>Account</code>.
  58. *
  59. * @param string $id
  60. * @param null|array $params
  61. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  62. *
  63. * @throws \Stripe\Exception\ApiErrorException if the request fails
  64. *
  65. * @return \Stripe\FinancialConnections\Account
  66. */
  67. public function refresh($id, $params = null, $opts = null)
  68. {
  69. return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/refresh', $id), $params, $opts);
  70. }
  71. /**
  72. * Retrieves the details of an Financial Connections <code>Account</code>.
  73. *
  74. * @param string $id
  75. * @param null|array $params
  76. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  77. *
  78. * @throws \Stripe\Exception\ApiErrorException if the request fails
  79. *
  80. * @return \Stripe\FinancialConnections\Account
  81. */
  82. public function retrieve($id, $params = null, $opts = null)
  83. {
  84. return $this->request('get', $this->buildPath('/v1/financial_connections/accounts/%s', $id), $params, $opts);
  85. }
  86. /**
  87. * Subscribes to periodic refreshes of data associated with a Financial Connections
  88. * <code>Account</code>.
  89. *
  90. * @param string $id
  91. * @param null|array $params
  92. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  93. *
  94. * @throws \Stripe\Exception\ApiErrorException if the request fails
  95. *
  96. * @return \Stripe\FinancialConnections\Account
  97. */
  98. public function subscribe($id, $params = null, $opts = null)
  99. {
  100. return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/subscribe', $id), $params, $opts);
  101. }
  102. /**
  103. * Unsubscribes from periodic refreshes of data associated with a Financial
  104. * Connections <code>Account</code>.
  105. *
  106. * @param string $id
  107. * @param null|array $params
  108. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  109. *
  110. * @throws \Stripe\Exception\ApiErrorException if the request fails
  111. *
  112. * @return \Stripe\FinancialConnections\Account
  113. */
  114. public function unsubscribe($id, $params = null, $opts = null)
  115. {
  116. return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/unsubscribe', $id), $params, $opts);
  117. }
  118. }