summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/Service/TransferService.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/stripe/stripe-php/lib/Service/TransferService.php')
-rw-r--r--vendor/stripe/stripe-php/lib/Service/TransferService.php350
1 files changed, 175 insertions, 175 deletions
diff --git a/vendor/stripe/stripe-php/lib/Service/TransferService.php b/vendor/stripe/stripe-php/lib/Service/TransferService.php
index 150bbf7..85664db 100644
--- a/vendor/stripe/stripe-php/lib/Service/TransferService.php
+++ b/vendor/stripe/stripe-php/lib/Service/TransferService.php
@@ -1,175 +1,175 @@
-<?php
-
-// File generated from our OpenAPI spec
-
-namespace Stripe\Service;
-
-class TransferService extends \Stripe\Service\AbstractService
-{
- /**
- * Returns a list of existing transfers sent to connected accounts. The transfers
- * are returned in sorted order, with the most recently created transfers appearing
- * first.
- *
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection
- */
- public function all($params = null, $opts = null)
- {
- return $this->requestCollection('get', '/v1/transfers', $params, $opts);
- }
-
- /**
- * You can see a list of the reversals belonging to a specific transfer. Note that
- * the 10 most recent reversals are always available by default on the transfer
- * object. If you need more than those 10, you can use this API method and the
- * <code>limit</code> and <code>starting_after</code> parameters to page through
- * additional reversals.
- *
- * @param string $parentId
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection
- */
- public function allReversals($parentId, $params = null, $opts = null)
- {
- return $this->requestCollection('get', $this->buildPath('/v1/transfers/%s/reversals', $parentId), $params, $opts);
- }
-
- /**
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Transfer
- */
- public function cancel($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/transfers/%s/cancel', $id), $params, $opts);
- }
-
- /**
- * To send funds from your Stripe account to a connected account, you create a new
- * transfer object. Your <a href="#balance">Stripe balance</a> must be able to
- * cover the transfer amount, or you’ll receive an “Insufficient Funds” error.
- *
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Transfer
- */
- public function create($params = null, $opts = null)
- {
- return $this->request('post', '/v1/transfers', $params, $opts);
- }
-
- /**
- * When you create a new reversal, you must specify a transfer to create it on.
- *
- * When reversing transfers, you can optionally reverse part of the transfer. You
- * can do so as many times as you wish until the entire transfer has been reversed.
- *
- * Once entirely reversed, a transfer can’t be reversed again. This method will
- * return an error when called on an already-reversed transfer, or when trying to
- * reverse more money than is left on a transfer.
- *
- * @param string $parentId
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\TransferReversal
- */
- public function createReversal($parentId, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/transfers/%s/reversals', $parentId), $params, $opts);
- }
-
- /**
- * Retrieves the details of an existing transfer. Supply the unique transfer ID
- * from either a transfer creation request or the transfer list, and Stripe will
- * return the corresponding transfer information.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Transfer
- */
- public function retrieve($id, $params = null, $opts = null)
- {
- return $this->request('get', $this->buildPath('/v1/transfers/%s', $id), $params, $opts);
- }
-
- /**
- * By default, you can see the 10 most recent reversals stored directly on the
- * transfer object, but you can also retrieve details about a specific reversal
- * stored on the transfer.
- *
- * @param string $parentId
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\TransferReversal
- */
- public function retrieveReversal($parentId, $id, $params = null, $opts = null)
- {
- return $this->request('get', $this->buildPath('/v1/transfers/%s/reversals/%s', $parentId, $id), $params, $opts);
- }
-
- /**
- * Updates the specified transfer by setting the values of the parameters passed.
- * Any parameters not provided will be left unchanged.
- *
- * This request accepts only metadata as an argument.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Transfer
- */
- public function update($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/transfers/%s', $id), $params, $opts);
- }
-
- /**
- * Updates the specified reversal by setting the values of the parameters passed.
- * Any parameters not provided will be left unchanged.
- *
- * This request only accepts metadata and description as arguments.
- *
- * @param string $parentId
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\TransferReversal
- */
- public function updateReversal($parentId, $id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/transfers/%s/reversals/%s', $parentId, $id), $params, $opts);
- }
-}
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace Stripe\Service;
+
+class TransferService extends \Stripe\Service\AbstractService
+{
+ /**
+ * Returns a list of existing transfers sent to connected accounts. The transfers
+ * are returned in sorted order, with the most recently created transfers appearing
+ * first.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Collection<\Stripe\Transfer>
+ */
+ public function all($params = null, $opts = null)
+ {
+ return $this->requestCollection('get', '/v1/transfers', $params, $opts);
+ }
+
+ /**
+ * You can see a list of the reversals belonging to a specific transfer. Note that
+ * the 10 most recent reversals are always available by default on the transfer
+ * object. If you need more than those 10, you can use this API method and the
+ * <code>limit</code> and <code>starting_after</code> parameters to page through
+ * additional reversals.
+ *
+ * @param string $parentId
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Collection<\Stripe\TransferReversal>
+ */
+ public function allReversals($parentId, $params = null, $opts = null)
+ {
+ return $this->requestCollection('get', $this->buildPath('/v1/transfers/%s/reversals', $parentId), $params, $opts);
+ }
+
+ /**
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Transfer
+ */
+ public function cancel($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/transfers/%s/cancel', $id), $params, $opts);
+ }
+
+ /**
+ * To send funds from your Stripe account to a connected account, you create a new
+ * transfer object. Your <a href="#balance">Stripe balance</a> must be able to
+ * cover the transfer amount, or you’ll receive an “Insufficient Funds” error.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Transfer
+ */
+ public function create($params = null, $opts = null)
+ {
+ return $this->request('post', '/v1/transfers', $params, $opts);
+ }
+
+ /**
+ * When you create a new reversal, you must specify a transfer to create it on.
+ *
+ * When reversing transfers, you can optionally reverse part of the transfer. You
+ * can do so as many times as you wish until the entire transfer has been reversed.
+ *
+ * Once entirely reversed, a transfer can’t be reversed again. This method will
+ * return an error when called on an already-reversed transfer, or when trying to
+ * reverse more money than is left on a transfer.
+ *
+ * @param string $parentId
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\TransferReversal
+ */
+ public function createReversal($parentId, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/transfers/%s/reversals', $parentId), $params, $opts);
+ }
+
+ /**
+ * Retrieves the details of an existing transfer. Supply the unique transfer ID
+ * from either a transfer creation request or the transfer list, and Stripe will
+ * return the corresponding transfer information.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Transfer
+ */
+ public function retrieve($id, $params = null, $opts = null)
+ {
+ return $this->request('get', $this->buildPath('/v1/transfers/%s', $id), $params, $opts);
+ }
+
+ /**
+ * By default, you can see the 10 most recent reversals stored directly on the
+ * transfer object, but you can also retrieve details about a specific reversal
+ * stored on the transfer.
+ *
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\TransferReversal
+ */
+ public function retrieveReversal($parentId, $id, $params = null, $opts = null)
+ {
+ return $this->request('get', $this->buildPath('/v1/transfers/%s/reversals/%s', $parentId, $id), $params, $opts);
+ }
+
+ /**
+ * Updates the specified transfer by setting the values of the parameters passed.
+ * Any parameters not provided will be left unchanged.
+ *
+ * This request accepts only metadata as an argument.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Transfer
+ */
+ public function update($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/transfers/%s', $id), $params, $opts);
+ }
+
+ /**
+ * Updates the specified reversal by setting the values of the parameters passed.
+ * Any parameters not provided will be left unchanged.
+ *
+ * This request only accepts metadata and description as arguments.
+ *
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\TransferReversal
+ */
+ public function updateReversal($parentId, $id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/transfers/%s/reversals/%s', $parentId, $id), $params, $opts);
+ }
+}