Merge pull request #210 from Famdirksen/pr-noteable-trait

Move notes on entities to Notable trait

Author: stephangroen

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

@@ -0,0 +1,30 @@
+<?php
+
+namespace Picqer\Financials\Moneybird\Actions;
+
+use Picqer\Financials\Moneybird\Entities\Note;
+use Picqer\Financials\Moneybird\Exceptions\ApiException;
+
+/**
+ * Class Noteable.
+ */
+trait Noteable
+{
+    use BaseTrait;
+
+    /**
+     * Add a note to the current object.
+     *
+     * @param Note $note
+     * @return $this
+     * @throws ApiException
+     */
+    public function addNote(Note $note)
+    {
+        $this->connection()->post($this->getEndpoint() . '/' . urlencode($this->id) . '/notes',
+            $note->jsonWithNamespace()
+        );
+
+        return $this;
+    }
+}

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

@@ -4,6 +4,7 @@
 
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Search;
 use Picqer\Financials\Moneybird\Actions\Storable;
@@ -19,7 +20,7 @@
  */
 class Contact extends Model
 {
-    use Search, FindAll, FindOne, Storable, Removable, Synchronizable;
+    use Search, FindAll, FindOne, Storable, Removable, Synchronizable, Noteable;
 
     /**
      * @var array
@@ -99,20 +100,4 @@ public function findByCustomerId($customerId)
 
         return $this->makeFromResponse($result);
     }
-
-    /**
-     * Add a note to the current contact.
-     *
-     * @param Note $note
-     * @return $this
-     * @throws ApiException
-     */
-    public function addNote(Note $note)
-    {
-        $this->connection()->post($this->endpoint . '/' . $this->id . '/notes',
-            $note->jsonWithNamespace()
-        );
-
-        return $this;
-    }
 }

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

@@ -7,6 +7,7 @@
 use Picqer\Financials\Moneybird\Actions\Filterable;
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Synchronizable;
@@ -23,7 +24,7 @@
  */
 class Estimate extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Synchronizable, Filterable, Downloadable;
+    use FindAll, FindOne, Storable, Removable, Synchronizable, Filterable, Downloadable, Noteable;
 
     /**
      * @var array

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

@@ -4,6 +4,7 @@
 
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Synchronizable;
@@ -14,7 +15,7 @@
  */
 class GeneralDocument extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Synchronizable;
+    use FindAll, FindOne, Storable, Removable, Synchronizable, Noteable;
 
     /**
      * @var array

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

@@ -4,6 +4,7 @@
 
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Model;
@@ -13,7 +14,7 @@
  */
 class GeneralJournalDocument extends Model
 {
-    use FindAll, FindOne, Storable, Removable;
+    use FindAll, FindOne, Storable, Removable, Noteable;
 
     /**
      * @var array

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

@@ -6,6 +6,7 @@
 use Picqer\Financials\Moneybird\Actions\Filterable;
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Synchronizable;
@@ -17,7 +18,7 @@
  */
 class PurchaseInvoice extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Filterable, Synchronizable, Attachment;
+    use FindAll, FindOne, Storable, Removable, Filterable, Synchronizable, Attachment, Noteable;
 
     /**
      * @var array

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

@@ -5,6 +5,7 @@
 use Picqer\Financials\Moneybird\Actions\Attachment;
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Exceptions\ApiException;
@@ -15,7 +16,7 @@
  */
 class Receipt extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Attachment;
+    use FindAll, FindOne, Storable, Removable, Attachment, Noteable;
 
     /**
      * @var array

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

@@ -5,6 +5,7 @@
 use Picqer\Financials\Moneybird\Actions\Filterable;
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Synchronizable;
@@ -15,7 +16,7 @@
  */
 class RecurringSalesInvoice extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Filterable, Synchronizable;
+    use FindAll, FindOne, Storable, Removable, Filterable, Synchronizable, Noteable;
 
     /**
      * @var array

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

@@ -8,6 +8,7 @@
 use Picqer\Financials\Moneybird\Actions\Filterable;
 use Picqer\Financials\Moneybird\Actions\FindAll;
 use Picqer\Financials\Moneybird\Actions\FindOne;
+use Picqer\Financials\Moneybird\Actions\Noteable;
 use Picqer\Financials\Moneybird\Actions\Removable;
 use Picqer\Financials\Moneybird\Actions\Storable;
 use Picqer\Financials\Moneybird\Actions\Synchronizable;
@@ -23,7 +24,7 @@
  */
 class SalesInvoice extends Model
 {
-    use FindAll, FindOne, Storable, Removable, Filterable, Downloadable, Synchronizable, Attachment;
+    use FindAll, FindOne, Storable, Removable, Filterable, Downloadable, Synchronizable, Attachment, Noteable;
 
     /**
      * @var array
@@ -217,22 +218,6 @@ public function deletePayment(SalesInvoicePayment $salesInvoicePayment)
         return $this;
     }
 
-    /**
-     * Add a note to the current invoice.
-     *
-     * @param Note $note
-     * @return $this
-     * @throws ApiException
-     */
-    public function addNote(Note $note)
-    {
-        $this->connection()->post($this->endpoint . '/' . $this->id . '/notes',
-            $note->jsonWithNamespace()
-        );
-
-        return $this;
-    }
-
     /**
      * Create a credit invoice based on the current invoice.
      *