9276396492

Committed 28 May 2024 09:10PM UTC coverage: 60.416% (-0.9%) from 61.314%

Build # 9276396492

Build Type

Pull #1699

github

Committed by

web-flow

Commit Message

Merge 23cfc8768 into 8661523be

Pull Request Pull Request #1699: Update generated code for beta

Run Details

1026 of 1732 new or added lines in 117 files covered. (59.24%)

15 existing lines in 3 files now uncovered.

3428 of 5674 relevant lines covered (60.42%)

2.17 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/lib/Treasury/OutboundPayment.php

<?php

// File generated from our OpenAPI spec

namespace Stripe\Treasury;

/**
 * Use OutboundPayments to send funds to another party's external bank account or <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount</a>. To send money to an account belonging to the same user, use an <a href="https://stripe.com/docs/api#outbound_transfers">OutboundTransfer</a>.
 *
 * Simulate OutboundPayment state changes with the <code>/v1/test_helpers/treasury/outbound_payments</code> endpoints. These methods can only be called on test mode objects.
 *
 * @property string $id Unique identifier for the object.
 * @property string $object String representing the object's type. Objects of the same type share the same value.
 * @property int $amount Amount (in cents) transferred.
 * @property bool $cancelable Returns <code>true</code> if the object can be canceled, and <code>false</code> otherwise.
 * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
 * @property null|string $customer ID of the <a href="https://stripe.com/docs/api/customers">customer</a> to whom an OutboundPayment is sent.
 * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
 * @property null|string $destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using <code>destination_payment_method_data</code>.
 * @property null|\Stripe\StripeObject $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment.
 * @property null|\Stripe\StripeObject $end_user_details Details about the end user.
 * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account.
 * @property string $financial_account The FinancialAccount that funds were pulled from.
 * @property null|string $hosted_regulatory_receipt_url A <a href="https://stripe.com/docs/treasury/moving-money/regulatory-receipts">hosted transaction receipt</a> URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
 * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
 * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
 * @property null|\Stripe\StripeObject $returned_details Details about a returned OutboundPayment. Only set when the status is <code>returned</code>.
 * @property string $statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
 * @property string $status Current status of the OutboundPayment: <code>processing</code>, <code>failed</code>, <code>posted</code>, <code>returned</code>, <code>canceled</code>. An OutboundPayment is <code>processing</code> if it has been created and is pending. The status changes to <code>posted</code> once the OutboundPayment has been &quot;confirmed&quot; and funds have left the account, or to <code>failed</code> or <code>canceled</code>. If an OutboundPayment fails to arrive at its destination, its status will change to <code>returned</code>.
 * @property \Stripe\StripeObject $status_transitions
 * @property null|\Stripe\StripeObject $tracking_details Details about network-specific tracking information if available.
 * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
 */
class OutboundPayment extends \Stripe\ApiResource
{
    const OBJECT_NAME = 'treasury.outbound_payment';

    const STATUS_CANCELED = 'canceled';
    const STATUS_FAILED = 'failed';
    const STATUS_POSTED = 'posted';
    const STATUS_PROCESSING = 'processing';
    const STATUS_RETURNED = 'returned';

    /**
     * Creates an OutboundPayment.
     *
     * @param null|mixed $params
     * @param null|mixed $options
     */
    public static function create($params = null, $options = null)
    {
        self::_validateParams($params);
        $url = static::classUrl();
        list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
        $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
        $obj->setLastResponse($response);

        return $obj;
    }

    /**
     * Returns a list of OutboundPayments sent from the specified FinancialAccount.
     *
     * @param null|mixed $params
     * @param null|mixed $opts
     */
    public static function all($params = null, $opts = null)
    {
        return static::_requestPage('/v1/treasury/outbound_payments', \Stripe\Collection::class, $params, $opts);
    }

    /**
     * Retrieves the details of an existing OutboundPayment by passing the unique
     * OutboundPayment ID from either the OutboundPayment creation request or
     * OutboundPayment list.
     *
     * @param mixed $id
     * @param null|mixed $opts
     */
    public static function retrieve($id, $opts = null)
    {
        $opts = \Stripe\Util\RequestOptions::parse($opts);
        $instance = new static($id, $opts);
        $instance->refresh();

        return $instance;
    }

    /**
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Treasury\OutboundPayment the canceled outbound payment
     */
    public function cancel($params = null, $opts = null)
    {
        $url = $this->instanceUrl() . '/cancel';
        list($response, $opts) = $this->_request('post', $url, $params, $opts);
        $this->refreshFrom($response, $opts);

        return $this;
    }
}

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Treasury;
6
7	/**
8	* Use OutboundPayments to send funds to another party's external bank account or <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount</a>. To send money to an account belonging to the same user, use an <a href="https://stripe.com/docs/api#outbound_transfers">OutboundTransfer</a>.
9	*
10	* Simulate OutboundPayment state changes with the <code>/v1/test_helpers/treasury/outbound_payments</code> endpoints. These methods can only be called on test mode objects.
11	*
12	* @property string $id Unique identifier for the object.
13	* @property string $object String representing the object's type. Objects of the same type share the same value.
14	* @property int $amount Amount (in cents) transferred.
15	* @property bool $cancelable Returns <code>true</code> if the object can be canceled, and <code>false</code> otherwise.
16	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
17	* @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
18	* @property null\|string $customer ID of the <a href="https://stripe.com/docs/api/customers">customer</a> to whom an OutboundPayment is sent.
19	* @property null\|string $description An arbitrary string attached to the object. Often useful for displaying to users.
20	* @property null\|string $destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using <code>destination_payment_method_data</code>.
21	* @property null\|\Stripe\StripeObject $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment.
22	* @property null\|\Stripe\StripeObject $end_user_details Details about the end user.
23	* @property int $expected_arrival_date The date when funds are expected to arrive in the destination account.
24	* @property string $financial_account The FinancialAccount that funds were pulled from.
25	* @property null\|string $hosted_regulatory_receipt_url A <a href="https://stripe.com/docs/treasury/moving-money/regulatory-receipts">hosted transaction receipt</a> URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
26	* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
27	* @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
28	* @property null\|\Stripe\StripeObject $returned_details Details about a returned OutboundPayment. Only set when the status is <code>returned</code>.
29	* @property string $statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
30	* @property string $status Current status of the OutboundPayment: <code>processing</code>, <code>failed</code>, <code>posted</code>, <code>returned</code>, <code>canceled</code>. An OutboundPayment is <code>processing</code> if it has been created and is pending. The status changes to <code>posted</code> once the OutboundPayment has been "confirmed" and funds have left the account, or to <code>failed</code> or <code>canceled</code>. If an OutboundPayment fails to arrive at its destination, its status will change to <code>returned</code>.
31	* @property \Stripe\StripeObject $status_transitions
32	* @property null\|\Stripe\StripeObject $tracking_details Details about network-specific tracking information if available.
33	* @property string\|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
34	*/
35	class OutboundPayment extends \Stripe\ApiResource
36	{
37	const OBJECT_NAME = 'treasury.outbound_payment';
38
39	const STATUS_CANCELED = 'canceled';
40	const STATUS_FAILED = 'failed';
41	const STATUS_POSTED = 'posted';
42	const STATUS_PROCESSING = 'processing';
43	const STATUS_RETURNED = 'returned';
44
45	/**
46	* Creates an OutboundPayment.
47	*
48	* @param null\|mixed $params
49	* @param null\|mixed $options
50	*/
NEW 51	public static function create($params = null, $options = null)	×
52	{
NEW 53	self::_validateParams($params);	×
NEW 54	$url = static::classUrl();	×
NEW 55	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);	×
NEW 56	$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);	×
NEW 57	$obj->setLastResponse($response);	×
58
NEW 59	return $obj;	×
60	}
61
62	/**
63	* Returns a list of OutboundPayments sent from the specified FinancialAccount.
64	*
65	* @param null\|mixed $params
66	* @param null\|mixed $opts
67	*/
NEW 68	public static function all($params = null, $opts = null)	×
69	{
NEW 70	return static::_requestPage('/v1/treasury/outbound_payments', \Stripe\Collection::class, $params, $opts);	×
71	}
72
73	/**
74	* Retrieves the details of an existing OutboundPayment by passing the unique
75	* OutboundPayment ID from either the OutboundPayment creation request or
76	* OutboundPayment list.
77	*
78	* @param mixed $id
79	* @param null\|mixed $opts
80	*/
NEW 81	public static function retrieve($id, $opts = null)	×
82	{
NEW 83	$opts = \Stripe\Util\RequestOptions::parse($opts);	×
NEW 84	$instance = new static($id, $opts);	×
NEW 85	$instance->refresh();	×
86
NEW 87	return $instance;	×
88	}
89
90	/**
91	* @param null\|array $params
92	* @param null\|array\|string $opts
93	*
94	* @throws \Stripe\Exception\ApiErrorException if the request fails
95	*
96	* @return \Stripe\Treasury\OutboundPayment the canceled outbound payment
97	*/
98	public function cancel($params = null, $opts = null)	×
99	{
100	$url = $this->instanceUrl() . '/cancel';	×
101	list($response, $opts) = $this->_request('post', $url, $params, $opts);	×
102	$this->refreshFrom($response, $opts);	×
103
104	return $this;	×
105	}
106	}

stripe / stripe-php / 9276396492

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous