Arcanedev\Stripe\Resources\Coupon

Complexity

Total Complexity

6

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	save()	0	4	1
A	delete()	0	4	1
A	all()	0	4	1
A	retrieve()	0	4	1
A	update()	0	4	1

<?php namespace Arcanedev\Stripe\Resources;

use Arcanedev\Stripe\Contracts\Resources\Coupon as CouponContract;
use Arcanedev\Stripe\StripeResource;

/**
 * Class     Coupon
 *
 * @package  Arcanedev\Stripe\Resources
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 * @link     https://stripe.com/docs/api/php#coupon_object
 *
 * @property  string                            id
 * @property  string                            object              // 'coupon'
 * @property  int                               amount_off
 * @property  int                               created             // timestamp
 * @property  string                            currency
 * @property  bool|null                         deleted
 * @property  string                            duration            // 'forever', 'once' or 'repeating'
 * @property  int                               duration_in_months
 * @property  bool                              livemode
 * @property  int                               max_redemptions
 * @property  \Arcanedev\Stripe\AttachedObject  metadata
 * @property  int                               percent_off
 * @property  int                               redeem_by           // timestamp
 * @property  int                               times_redeemed
 * @property  bool                              valid
 */
class Coupon extends StripeResource implements CouponContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * List all Coupons.
     * @link   https://stripe.com/docs/api/php#list_coupons
     *
     * @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);
    }

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

    /**
     * Create a Coupon.
     * @link   https://stripe.com/docs/api/php#create_coupon
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self|array
     */
    public static function create($params = [], $options = null)
    {
        return self::scopedCreate($params, $options);
    }

    /**
     * Update a Coupon.
     * @link   https://stripe.com/docs/api/php#update_coupon
     *
     * @param  string             $id
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self
     */
    public static function update($id, $params = [], $options = null)
    {
        return self::scopedUpdate($id, $params, $options);
    }

    /**
     * Update/Save a Coupon.
     * @link   https://stripe.com/docs/api/php#update_coupon
     *
     * @param  array|string|null  $options
     *
     * @return self
     */
    public function save($options = null)
    {
        return self::scopedSave($options);
    }

    /**
     * Delete a Coupon.
     * @link   https://stripe.com/docs/api/php#delete_coupon
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self
     */
    public function delete($params = [], $options = null)
    {
        return self::scopedDelete($params, $options);
    }
}