upgrade

vendor/stripe/stripe-php/lib/Service/PayoutService.php

@@ -0,0 +1,132 @@
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace Stripe\Service;
+
+/**
+ * @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
+ *
+ * @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
+ */
+class PayoutService extends AbstractService
+{
+    /**
+     * Returns a list of existing payouts sent to third-party bank accounts or payouts
+     * that Stripe sent to you. The payouts return in sorted order, with the most
+     * recently created payouts appearing first.
+     *
+     * @param null|array{arrival_date?: array|int, created?: array|int, destination?: string, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params
+     * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
+     *
+     * @return \Stripe\Collection<\Stripe\Payout>
+     *
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     */
+    public function all($params = null, $opts = null)
+    {
+        return $this->requestCollection('get', '/v1/payouts', $params, $opts);
+    }
+
+    /**
+     * You can cancel a previously created payout if its status is
+     * <code>pending</code>. Stripe refunds the funds to your available balance. You
+     * can’t cancel automatic Stripe payouts.
+     *
+     * @param string $id
+     * @param null|array{expand?: string[]} $params
+     * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
+     *
+     * @return \Stripe\Payout
+     *
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     */
+    public function cancel($id, $params = null, $opts = null)
+    {
+        return $this->request('post', $this->buildPath('/v1/payouts/%s/cancel', $id), $params, $opts);
+    }
+
+    /**
+     * To send funds to your own bank account, create a new payout object. Your <a
+     * href="#balance">Stripe balance</a> must cover the payout amount. If it doesn’t,
+     * you receive an “Insufficient Funds” error.
+     *
+     * If your API key is in test mode, money won’t actually be sent, though every
+     * other action occurs as if you’re in live mode.
+     *
+     * If you create a manual payout on a Stripe account that uses multiple payment
+     * source types, you need to specify the source type balance that the payout draws
+     * from. The <a href="#balance_object">balance object</a> details available and
+     * pending amounts by source type.
+     *
+     * @param null|array{amount: int, currency: string, description?: string, destination?: string, expand?: string[], metadata?: array<string, string>, method?: string, source_type?: string, statement_descriptor?: string} $params
+     * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
+     *
+     * @return \Stripe\Payout
+     *
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     */
+    public function create($params = null, $opts = null)
+    {
+        return $this->request('post', '/v1/payouts', $params, $opts);
+    }
+
+    /**
+     * Retrieves the details of an existing payout. Supply the unique payout ID from
+     * either a payout creation request or the payout list. Stripe returns the
+     * corresponding payout information.
+     *
+     * @param string $id
+     * @param null|array{expand?: string[]} $params
+     * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
+     *
+     * @return \Stripe\Payout
+     *
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     */
+    public function retrieve($id, $params = null, $opts = null)
+    {
+        return $this->request('get', $this->buildPath('/v1/payouts/%s', $id), $params, $opts);
+    }
+
+    /**
+     * Reverses a payout by debiting the destination bank account. At this time, you
+     * can only reverse payouts for connected accounts to US bank accounts. If the
+     * payout is manual and in the <code>pending</code> status, use
+     * <code>/v1/payouts/:id/cancel</code> instead.
+     *
+     * By requesting a reversal through <code>/v1/payouts/:id/reverse</code>, you
+     * confirm that the authorized signatory of the selected bank account authorizes
+     * the debit on the bank account and that no other authorization is required.
+     *
+     * @param string $id
+     * @param null|array{expand?: string[], metadata?: array<string, string>} $params
+     * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
+     *
+     * @return \Stripe\Payout
+     *
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     */
+    public function reverse($id, $params = null, $opts = null)
+    {
+        return $this->request('post', $this->buildPath('/v1/payouts/%s/reverse', $id), $params, $opts);
+    }
+
+    /**
+     * Updates the specified payout by setting the values of the parameters you pass.
+     * We don’t change parameters that you don’t provide. This request only accepts the
+     * metadata as arguments.
+     *
+     * @param string $id
+     * @param null|array{expand?: string[], metadata?: null|array<string, string>} $params
+     * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
+     *
+     * @return \Stripe\Payout
+     *
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     */
+    public function update($id, $params = null, $opts = null)
+    {
+        return $this->request('post', $this->buildPath('/v1/payouts/%s', $id), $params, $opts);
+    }
+}