vendor/stripe/stripe-php/lib/ApplicationFee.php

   1 <?php
   2
   3 namespace Stripe;
   4
   5 /**
   6  * Class ApplicationFee
   7  *
   8  * @property string $id
   9  * @property string $object
  10  * @property string $account
  11  * @property int $amount
  12  * @property int $amount_refunded
  13  * @property string $application
  14  * @property string $balance_transaction
  15  * @property string $charge
  16  * @property int $created
  17  * @property string $currency
  18  * @property bool $livemode
  19  * @property string $originating_transaction
  20  * @property bool $refunded
  21  * @property Collection $refunds
  22  *
  23  * @package Stripe
  24  */
  25 class ApplicationFee extends ApiResource
  26 {
  27
  28     const OBJECT_NAME = "application_fee";
  29
  30     use ApiOperations\All;
  31     use ApiOperations\NestedResource;
  32     use ApiOperations\Retrieve;
  33
  34     const PATH_REFUNDS = '/refunds';
  35
  36     /**
  37      * This is a special case because the application fee endpoint has an
  38      *    underscore in it. The parent `className` function strips underscores.
  39      *
  40      * @return string The name of the class.
  41      */
  42     public static function className()
  43     {
  44         return 'application_fee';
  45     }
  46
  47     /**
  48      * @param array|null $params
  49      * @param array|string|null $opts
  50      *
  51      * @return ApplicationFee The refunded application fee.
  52      */
  53     public function refund($params = null, $opts = null)
  54     {
  55         $this->refunds->create($params, $opts);
  56         $this->refresh();
  57         return $this;
  58     }
  59
  60     /**
  61      * @param array|null $id The ID of the application fee on which to create the refund.
  62      * @param array|null $params
  63      * @param array|string|null $opts
  64      *
  65      * @return ApplicationFeeRefund
  66      */
  67     public static function createRefund($id, $params = null, $opts = null)
  68     {
  69         return self::_createNestedResource($id, static::PATH_REFUNDS, $params, $opts);
  70     }
  71
  72     /**
  73      * @param array|null $id The ID of the application fee to which the refund belongs.
  74      * @param array|null $refundId The ID of the refund to retrieve.
  75      * @param array|null $params
  76      * @param array|string|null $opts
  77      *
  78      * @return ApplicationFeeRefund
  79      */
  80     public static function retrieveRefund($id, $refundId, $params = null, $opts = null)
  81     {
  82         return self::_retrieveNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $opts);
  83     }
  84
  85     /**
  86      * @param array|null $id The ID of the application fee to which the refund belongs.
  87      * @param array|null $refundId The ID of the refund to update.
  88      * @param array|null $params
  89      * @param array|string|null $opts
  90      *
  91      * @return ApplicationFeeRefund
  92      */
  93     public static function updateRefund($id, $refundId, $params = null, $opts = null)
  94     {
  95         return self::_updateNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $opts);
  96     }
  97
  98     /**
  99      * @param array|null $id The ID of the application fee on which to retrieve the refunds.
 100      * @param array|null $params
 101      * @param array|string|null $opts
 102      *
 103      * @return ApplicationFeeRefund
 104      */
 105     public static function allRefunds($id, $params = null, $opts = null)
 106     {
 107         return self::_allNestedResources($id, static::PATH_REFUNDS, $params, $opts);
 108     }
 109 }