Merge pull request #811 from stripe/remi-creditnote-preview

Add support for `CreditNote` preview.

.travis.yml

@@ -42,7 +42,7 @@ matrix:
 
 env:
   global:
-    - STRIPE_MOCK_VERSION=0.72.0
+    - STRIPE_MOCK_VERSION=0.76.0
 cache:
   directories:
     - $HOME/.composer/cache/files

lib/CreditNote.php

@@ -58,6 +58,23 @@ class CreditNote extends ApiResource
     const TYPE_POST_PAYMENT = 'post_payment';
     const TYPE_PRE_PAYMENT  = 'pre_payment';
 
+    /**
+     * @param array|null $params
+     * @param array|string|null $opts
+     *
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     *
+     * @return CreditNote The previewed credit note.
+     */
+    public static function preview($params = null, $opts = null)
+    {
+        $url = static::classUrl() . '/preview';
+        list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
+        $obj = Util\Util::convertToStripeObject($response->json, $opts);
+        $obj->setLastResponse($response);
+        return $obj;
+    }
+
     /**
      * @param array|null $params
      * @param array|string|null $opts

tests/Stripe/CreditNoteTest.php

@@ -65,6 +65,19 @@ public function testIsUpdatable()
         $this->assertInstanceOf(\Stripe\CreditNote::class, $resource);
     }
 
+    public function testCanPreview()
+    {
+        $this->expectsRequest(
+            'get',
+            '/v1/credit_notes/preview'
+        );
+        $resource = CreditNote::preview([
+            'amount' => 100,
+            'invoice' => 'in_123',
+        ]);
+        $this->assertInstanceOf(\Stripe\CreditNote::class, $resource);
+    }
+
     public function testCanVoidCreditNote()
     {
         $creditNote = CreditNote::retrieve(self::TEST_RESOURCE_ID);

tests/bootstrap.php

@@ -2,7 +2,7 @@
 
 require_once(__DIR__ . '/StripeMock.php');
 
-define("MOCK_MINIMUM_VERSION", "0.72.0");
+define("MOCK_MINIMUM_VERSION", "0.76.0");
 
 if (\Stripe\StripeMock::start()) {
     register_shutdown_function('\Stripe\StripeMock::stop');