Arcanedev\Stripe\Resources\OrderReturn

Complexity

Total Complexity

3

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	className()	0	4	1
A	retrieve()	0	4	1
A	all()	0	4	1

<?php namespace Arcanedev\Stripe\Resources;

use Arcanedev\Stripe\Contracts\Resources\OrderReturn as OrderReturnContract;
use Arcanedev\Stripe\StripeResource;

/**
 * Class     OrderReturn
 *
 * @package  Arcanedev\Stripe\Resources
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 * @link     https://stripe.com/docs/api/php#order_return_object
 *
 * @property  string                                  id
 * @property  string                                  object    // 'order_return'
 * @property  int                                     amount
 * @property  int                                     created   // timestamp
 * @property  string                                  currency
 * @property  array                                   items
 * @property  bool                                    livemode
 * @property  string                                  order
 * @property  string                                  refund
 */
class OrderReturn extends StripeResource implements OrderReturnContract
{
    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * This is a special case because the order returns endpoint has an underscore in it.
     * The parent `className` function strips underscores.
     *
     * @param  string  $class
     *
     * @return string
     */
    public static function className($class = '')
    {
        return 'order_return';
    }

    /**
     * Retrieve an order return.
     * @link   https://stripe.com/docs/api/php#retrieve_order_return
     *
     * @param  string             $id
     * @param  array|string|null  $options
     *
     * @return self
     */
    public static function retrieve($id, $options = null)
    {
        return self::scopedRetrieve($id, $options);
    }

    /**
     * List all order returns.
     * @link   https://stripe.com/docs/api/php#list_order_returns
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return \Arcanedev\Stripe\Collection|array
     */
    public static function all($params = [], $options = null)
    {
        return self::scopedAll($params, $options);
    }
}