Add onboarding endpoint (#382)

Big thanks to @LauLaman !

src/Endpoints/ChargebackEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Chargeback;
 use Mollie\Api\Resources\ChargebackCollection;
 
-class ChargebackEndpoint extends EndpointAbstract
+class ChargebackEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "chargebacks";
 

src/Endpoints/CollectionEndpointAbstract.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Mollie\Api\Endpoints;
+
+use Mollie\Api\Resources\BaseCollection;
+
+abstract class CollectionEndpointAbstract extends EndpointAbstract
+{
+    /**
+     * Get the collection object that is used by this API endpoint. Every API endpoint uses one type of collection object.
+     *
+     * @param int $count
+     * @param object[] $_links
+     *
+     * @return BaseCollection
+     */
+    abstract protected function getResourceCollectionObject($count, $_links);
+}

src/Endpoints/CustomerEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Customer;
 use Mollie\Api\Resources\CustomerCollection;
 
-class CustomerEndpoint extends EndpointAbstract
+class CustomerEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "customers";
 

src/Endpoints/CustomerPaymentsEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentCollection;
 
-class CustomerPaymentsEndpoint extends EndpointAbstract
+class CustomerPaymentsEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "customers_payments";
 
@@ -94,4 +94,4 @@ public function listForId($customerId, $from = null, $limit = null, array $param
 
         return parent::rest_list($from, $limit, $parameters);
     }
-}
+}

src/Endpoints/EndpointAbstract.php

@@ -166,16 +166,6 @@ protected function rest_list($from = null, $limit = null, array $filters)
      */
     abstract protected function getResourceObject();
 
-    /**
-     * Get the collection object that is used by this API endpoint. Every API endpoint uses one type of collection object.
-     *
-     * @param int $count
-     * @param object[] $_links
-     *
-     * @return BaseCollection
-     */
-    abstract protected function getResourceCollectionObject($count, $_links);
-
     /**
      * @param string $resourcePath
      */

src/Endpoints/InvoiceEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Invoice;
 use Mollie\Api\Resources\InvoiceCollection;
 
-class InvoiceEndpoint extends EndpointAbstract
+class InvoiceEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "invoices";
 
@@ -75,4 +75,4 @@ public function all(array $parameters = [])
     {
         return $this->page( null, null, $parameters);
     }
-}
+}

src/Endpoints/MandateEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\Mandate;
 use Mollie\Api\Resources\MandateCollection;
 
-class MandateEndpoint extends EndpointAbstract
+class MandateEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "customers_mandates";
 
@@ -147,4 +147,4 @@ public function revokeForId($customerId, $mandateId, $data = [])
 
         return parent::rest_delete($mandateId, $data);
     }
-}
+}

src/Endpoints/MethodEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\MethodCollection;
 use Mollie\Api\Resources\ResourceFactory;
 
-class MethodEndpoint extends EndpointAbstract
+class MethodEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "methods";
 

src/Endpoints/OnboardingEndpoint.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Mollie\Api\Endpoints;
+
+use Mollie\Api\Exceptions\ApiException;
+use Mollie\Api\Resources\BaseResource;
+use Mollie\Api\Resources\Onboarding;
+use Mollie\Api\Resources\ResourceFactory;
+
+class OnboardingEndpoint extends EndpointAbstract
+{
+    protected $resourcePath = "onboarding/me";
+
+    /**
+     * Get the object that is used by this API endpoint. Every API endpoint uses one type of object.
+     *
+     * @return BaseResource
+     */
+    protected function getResourceObject()
+    {
+        return new Onboarding($this->client);
+    }
+
+    /**
+     * Retrieve the organization's onboarding status from Mollie.
+     *
+     * Will throw a ApiException if the resource cannot be found.
+     *
+     * @return Onboarding
+     * @throws ApiException
+     */
+    public function get()
+    {
+        return $this->rest_read('', []);
+    }
+
+    /**
+     * Submit data that will be prefilled in the merchant’s onboarding.
+     * Please note that the data you submit will only be processed when the onboarding status is needs-data.
+     *
+     * Information that the merchant has entered in their dashboard will not be overwritten.
+     *
+     * Will throw a ApiException if the resource cannot be found.
+     *
+     * @return void
+     * @throws ApiException
+     */
+    public function submit(array $parameters = [])
+    {
+
+        return $this->rest_create($parameters, []);
+    }
+
+    protected function rest_read($id, array $filters)
+    {
+        $result = $this->client->performHttpCall(
+            self::REST_READ,
+            $this->getResourcePath() . $this->buildQueryString($filters)
+        );
+
+        return ResourceFactory::createFromApiResult($result, $this->getResourceObject());
+    }
+
+    protected function rest_create(array $body, array $filters)
+    {
+        $this->client->performHttpCall(
+            self::REST_CREATE,
+            $this->getResourcePath() . $this->buildQueryString($filters),
+            $this->parseRequestBody($body)
+        );
+    }
+}

src/Endpoints/OrderEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Order;
 use Mollie\Api\Resources\OrderCollection;
 
-class OrderEndpoint extends EndpointAbstract
+class OrderEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "orders";
 

src/Endpoints/OrderLineEndpoint.php

@@ -8,7 +8,7 @@
 use Mollie\Api\Resources\OrderLineCollection;
 use Mollie\Api\Resources\ResourceFactory;
 
-class OrderLineEndpoint extends EndpointAbstract
+class OrderLineEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "orders_lines";
 

src/Endpoints/OrderPaymentEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentCollection;
 
-class OrderPaymentEndpoint extends EndpointAbstract
+class OrderPaymentEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "orders_payments";
 

src/Endpoints/OrderRefundEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Refund;
 use Mollie\Api\Resources\RefundCollection;
 
-class OrderRefundEndpoint extends EndpointAbstract
+class OrderRefundEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "orders_refunds";
 

src/Endpoints/OrganizationEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\Organization;
 use Mollie\Api\Resources\OrganizationCollection;
 
-class OrganizationEndpoint extends EndpointAbstract
+class OrganizationEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "organizations";
 

src/Endpoints/PaymentCaptureEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\CaptureCollection;
 use Mollie\Api\Resources\Payment;
 
-class PaymentCaptureEndpoint extends EndpointAbstract
+class PaymentCaptureEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "payments_captures";
 

src/Endpoints/PaymentChargebackEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\ChargebackCollection;
 use Mollie\Api\Resources\Payment;
 
-class PaymentChargebackEndpoint extends EndpointAbstract
+class PaymentChargebackEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "payments_chargebacks";
 

src/Endpoints/PaymentEndpoint.php

@@ -8,7 +8,7 @@
 use Mollie\Api\Resources\Refund;
 use Mollie\Api\Resources\ResourceFactory;
 
-class PaymentEndpoint extends EndpointAbstract
+class PaymentEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "payments";
 

src/Endpoints/PaymentRefundEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Refund;
 use Mollie\Api\Resources\RefundCollection;
 
-class PaymentRefundEndpoint extends EndpointAbstract
+class PaymentRefundEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "payments_refunds";
 

src/Endpoints/PermissionEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Permission;
 use Mollie\Api\Resources\PermissionCollection;
 
-class PermissionEndpoint extends EndpointAbstract
+class PermissionEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "permissions";
 

src/Endpoints/ProfileEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\Profile;
 use Mollie\Api\Resources\ProfileCollection;
 
-class ProfileEndpoint extends EndpointAbstract
+class ProfileEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "profiles";
     protected $resourceClass = Profile::class;
@@ -117,4 +117,4 @@ public function page($from = null, $limit = null, array $parameters = [])
     }
 
 
-}
+}

src/Endpoints/ProfileMethodEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\Profile;
 use Mollie\Api\Resources\ResourceFactory;
 
-class ProfileMethodEndpoint extends EndpointAbstract
+class ProfileMethodEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "profiles_methods";
 

src/Endpoints/RefundEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Refund;
 use Mollie\Api\Resources\RefundCollection;
 
-class RefundEndpoint extends EndpointAbstract
+class RefundEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "refunds";
 

src/Endpoints/SettlementsEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Settlement;
 use Mollie\Api\Resources\SettlementCollection;
 
-class SettlementsEndpoint extends EndpointAbstract
+class SettlementsEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "settlements";
 
@@ -84,4 +84,4 @@ public function page($from = null, $limit = null, array $parameters = [])
     {
         return $this->rest_list($from, $limit, $parameters);
     }
-}
+}

src/Endpoints/ShipmentEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Shipment;
 use Mollie\Api\Resources\ShipmentCollection;
 
-class ShipmentEndpoint extends EndpointAbstract
+class ShipmentEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "orders_shipments";
 

src/Endpoints/SubscriptionEndpoint.php

@@ -8,7 +8,7 @@
 use Mollie\Api\Resources\Subscription;
 use Mollie\Api\Resources\SubscriptionCollection;
 
-class SubscriptionEndpoint extends EndpointAbstract
+class SubscriptionEndpoint extends CollectionEndpointAbstract
 {
     protected $resourcePath = "customers_subscriptions";
 
@@ -94,4 +94,4 @@ public function cancelFor(Customer $customer, $subscriptionId, array $data = [])
 
         return parent::rest_delete($subscriptionId, $data);
     }
-}
+}

src/MollieApiClient.php

@@ -12,6 +12,7 @@
 use Mollie\Api\Endpoints\InvoiceEndpoint;
 use Mollie\Api\Endpoints\MandateEndpoint;
 use Mollie\Api\Endpoints\MethodEndpoint;
+use Mollie\Api\Endpoints\OnboardingEndpoint;
 use Mollie\Api\Endpoints\OrderEndpoint;
 use Mollie\Api\Endpoints\OrderLineEndpoint;
 use Mollie\Api\Endpoints\OrderPaymentEndpoint;
@@ -156,6 +157,13 @@ class MollieApiClient
      */
     public $invoices;
 
+    /**
+     * RESTful Onboarding resource.
+     *
+     * @var OnboardingEndpoint
+     */
+    public $onboarding;
+
     /**
      * RESTful Order resource.
      *
@@ -242,7 +250,6 @@ class MollieApiClient
      * @var array
      */
     protected $versionStrings = [];
-
     /**
      * @var int
      */
@@ -285,6 +292,7 @@ public function initializeEndpoints()
         $this->invoices = new InvoiceEndpoint($this);
         $this->permissions = new PermissionEndpoint($this);
         $this->profiles = new ProfileEndpoint($this);
+        $this->onboarding = new OnboardingEndpoint($this);
         $this->organizations = new OrganizationEndpoint($this);
         $this->orders = new OrderEndpoint($this);
         $this->orderLines = new OrderLineEndpoint($this);