Merge pull request #192 from enflow-nl/feature/official-download-endpoint

Move SalesInvoice & Estimate download to the official endpoint

Author: stephangroen

src/Picqer/Financials/Moneybird/Actions/Downloadable.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Picqer\Financials\Moneybird\Actions;
+
+/**
+ * Class Downloadable.
+ */
+trait Downloadable
+{
+    use BaseTrait;
+
+    /**
+     * Download as PDF.
+     *
+     * @return string PDF file data
+     *
+     * @throws \Picqer\Financials\Moneybird\Exceptions\ApiException
+     */
+    public function download()
+    {
+        $response = $this->connection()->download($this->getEndpoint() . '/' . urlencode($this->id) . '/download_pdf');
+
+        return $response->getBody()->getContents();
+    }
+}

src/Picqer/Financials/Moneybird/Actions/PrivateDownloadable.php

@@ -3,15 +3,15 @@
 namespace Picqer\Financials\Moneybird;
 
 use Exception;
-use GuzzleHttp\Psr7;
 use GuzzleHttp\Client;
+use GuzzleHttp\Exception\BadResponseException;
 use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Psr7;
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
-use Psr\Http\Message\ResponseInterface;
-use GuzzleHttp\Exception\BadResponseException;
-use Picqer\Financials\Moneybird\Exceptions\ApiException;
 use Picqer\Financials\Moneybird\Exceptions\Api\TooManyRequestsException;
+use Picqer\Financials\Moneybird\Exceptions\ApiException;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * Class Connection.
@@ -287,6 +287,23 @@ public function delete($url, $body = null)
         }
     }
 
+    /**
+     * @param string $url
+     * @param array $options
+     * @return mixed
+     * @throws ApiException
+     */
+    public function download($url, $options = [])
+    {
+        try {
+            $request = $this->createRequestNoJson('GET', $this->formatUrl($url, 'get'), null);
+
+            return $this->client()->send($request, $options);
+        } catch (Exception $e) {
+            $this->parseExceptionForErrorMessages($e);
+        }
+    }
+
     /**
      * @param string $url
      * @param array $options

src/Picqer/Financials/Moneybird/Connection.php

@@ -3,15 +3,15 @@
 namespace Picqer\Financials\Moneybird\Entities;
 
 use InvalidArgumentException;
-use Picqer\Financials\Moneybird\Model;
+use Picqer\Financials\Moneybird\Actions\Downloadable;
+use Picqer\Financials\Moneybird\Actions\Filterable;
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
-use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Removable;
-use Picqer\Financials\Moneybird\Actions\Filterable;
+use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Synchronizable;
-use Picqer\Financials\Moneybird\Actions\PrivateDownloadable;
 use Picqer\Financials\Moneybird\Entities\SalesInvoice\SendInvoiceOptions;
+use Picqer\Financials\Moneybird\Model;
 
 /**
  * Class Contact.
@@ -23,7 +23,7 @@
  */
 class Estimate extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Synchronizable, Filterable, PrivateDownloadable;
+    use FindAll, FindOne, Storable, Removable, Synchronizable, Filterable, Downloadable;
 
     /**
      * @var array

src/Picqer/Financials/Moneybird/Entities/Estimate.php

@@ -3,16 +3,16 @@
 namespace Picqer\Financials\Moneybird\Entities;
 
 use InvalidArgumentException;
-use Picqer\Financials\Moneybird\Model;
+use Picqer\Financials\Moneybird\Actions\Downloadable;
+use Picqer\Financials\Moneybird\Actions\Filterable;
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
-use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Removable;
-use Picqer\Financials\Moneybird\Actions\Filterable;
+use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Synchronizable;
-use Picqer\Financials\Moneybird\Exceptions\ApiException;
-use Picqer\Financials\Moneybird\Actions\PrivateDownloadable;
 use Picqer\Financials\Moneybird\Entities\SalesInvoice\SendInvoiceOptions;
+use Picqer\Financials\Moneybird\Exceptions\ApiException;
+use Picqer\Financials\Moneybird\Model;
 
 /**
  * Class SalesInvoice.
@@ -22,7 +22,7 @@
  */
 class SalesInvoice extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Filterable, PrivateDownloadable, Synchronizable;
+    use FindAll, FindOne, Storable, Removable, Filterable, Downloadable, Synchronizable;
 
     /**
      * @var array