Arcanedev\Stripe\Resources\ApplicationFee

Complexity

Total Complexity

8

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

66.67%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	className()	0	4	1
A	all()	0	4	1
A	retrieve()	0	4	1
A	refund()	0	7	1
A	createRefund()	0	4	1
A	retrieveRefund()	0	4	1
A	updateRefund()	0	4	1
A	allRefunds()	0	4	1

<?php namespace Arcanedev\Stripe\Resources;

use Arcanedev\Stripe\Contracts\Resources\ApplicationFee as ApplicationFeeContract;
use Arcanedev\Stripe\StripeResource;

/**
 * Class     ApplicationFee
 *
 * @package  Arcanedev\Stripe\Resources
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 * @link     https://stripe.com/docs/api/php#application_fees
 *
 * @property  string                        id
 * @property  string                        object                   // "application_fee"
 * @property  string                        account
 * @property  int                           amount
 * @property  int                           amount_refunded
 * @property  string                        application
 * @property  string                        balance_transaction
 * @property  string                        charge
 * @property  int                           created                  // timestamp
 * @property  string                        currency
 * @property  bool                          livemode
 * @property  string                        originating_transaction
 * @property  bool                          refunded
 * @property  \Arcanedev\Stripe\Collection  refunds
 */
class ApplicationFee extends StripeResource implements ApplicationFeeContract
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    const PATH_REFUNDS = '/refunds';

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

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

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

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

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

    /**
     * Creating an Application Fee Refund.
     *
     * @link   https://stripe.com/docs/api/php#create_fee_refund
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self
     */
    public function refund($params = [], $options = null)
    {
        $this->refunds->create($params, $options);
        $this->refresh();

        return $this;
    }

    /**
     * Create a refund.
     *
     * @param  string             $id
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return \Arcanedev\Stripe\Resources\ApplicationFeeRefund
     */
    public static function createRefund($id, $params = null, $options = null)
    {
        return self::createNestedResource($id, static::PATH_REFUNDS, $params, $options);
    }

    /**
     * Retrieve a refund.
     *
     * @param  string             $id
     * @param  string             $refundId
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return \Arcanedev\Stripe\Resources\ApplicationFeeRefund
     */
    public static function retrieveRefund($id, $refundId, $params = null, $options = null)
    {
        return self::retrieveNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $options);
    }

    /**
     * Update a refund.
     *
     * @param  string             $id
     * @param  string             $refundId
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return \Arcanedev\Stripe\Resources\ApplicationFeeRefund
     */
    public static function updateRefund($id, $refundId, $params = null, $options = null)
    {
        return self::updateNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $options);
    }

    /**
     * Get all the refund.
     *
     * @param  string             $id
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return \Arcanedev\Stripe\Collection
     */
    public static function allRefunds($id, $params = null, $options = null)
    {
        return self::allNestedResources($id, static::PATH_REFUNDS, $params, $options);
    }
}