Refactoring of namespace ++; Added documentation & dynamic links

Author: daniel-zahariev

README.md

@@ -40,7 +40,6 @@ Each resource (class) can be accessed via magic property on the Merchants API ob
 ```php
 $merchant_api->api_keys->...;
 $merchant_api->balance->...;
-$merchant_api->dynamic_links->...;
 $merchant_api->payment_requests->...;
 $merchant_api->payment_sends->...;
 $merchant_api->pos->...;
@@ -66,7 +65,7 @@ Only `PaymentRequests` class has a few extra helper methods:
 $merchant_api->payment_requests->capture($payment_request_id,$currency,$amount)
 $merchant_api->payment_requests->refund($payment_request_id, $currency, $amount);
 $merchant_api->payment_requests->getPaymentLink($payment_request_id);
-$merchant_api->payment_requests->getMobilePaymentLink($payment_request_id);
+$merchant_api->payment_requests->getDynamicLink($payment_request_id);
 ```
 
 
@@ -90,3 +89,10 @@ Here's an example for nginx:
 proxy_set_header Authorization $http_authorization;
 proxy_pass_header  Authorization;
 ```
+
+Two methods on the `SettleApiClient` class can be used in relation to the callbacks:
+
+```php
+// the following will return 
+$settle_client->isValidCallback($callbackUrl, $body, $headers, $method); 
+```

composer.json

@@ -17,13 +17,13 @@
         "ext-openssl": "*"
     },
     "require-dev": {
-        "pestphp/pest": "^1.20",
-        "php-coveralls/php-coveralls": "^2.4",
-        "vlucas/phpdotenv": "^5.3"
+        "pestphp/pest": "^1.21",
+        "php-coveralls/php-coveralls": "^2.5",
+        "vlucas/phpdotenv": "^5.4"
     },
     "autoload": {
         "psr-4": {
-            "Danielz\\SettleApi\\": "src/"
+            "SettleApi\\": "src/"
         }
     },
     "scripts": {

src/MerchantApi/ApiKeys.php

@@ -1,13 +1,14 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
-use Danielz\SettleApi\SettleApiException;
+use SettleApi\SettleApi;
+use SettleApi\SettleApiException;
 
 /**
  * Class ApiKeys
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
+ * @link https://api.support.settle.eu/api/reference/rest/v1/merchant.apiKeys/
  */
 class ApiKeys extends SettleApi
 {

src/MerchantApi/Balance.php

@@ -1,13 +1,14 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
-use Danielz\SettleApi\SettleApiException;
+use SettleApi\SettleApi;
+use SettleApi\SettleApiException;
 
 /**
  * Class Balance
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
+ * @link https://api.support.settle.eu/api/reference/rest/v1/merchant.balance/
  */
 class Balance extends SettleApi
 {

src/MerchantApi/MerchantApi.php

@@ -1,19 +1,19 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
+use SettleApi\SettleApi;
 
 /**
  * Class MerchantApi
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
  *
  * @property ApiKeys api_keys
  * @property PaymentRequests payment_requests
  * @property PaymentSends payment_sends
  * @property Pos pos
  * @property Settlements settlements
- * @property Shortlinks shortlinks
+ * @property ShortLinks short_links
  * @property Balance balance
  * @property Profile profile
  * @property StatusCodes status_codes
@@ -33,7 +33,7 @@ protected function getMagicProperties()
             'pos' => Pos::class,
             'profile' => Profile::class,
             'settlements' => Settlements::class,
-            'shortlinks' => Shortlinks::class,
+            'short_links' => ShortLinks::class,
             'status_codes' => StatusCodes::class,
         ];
     }

src/MerchantApi/PaymentRequests.php

@@ -1,13 +1,15 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
-use Danielz\SettleApi\SettleApiException;
+use SettleApi\SettleApi;
+use SettleApi\SettleApiClient;
+use SettleApi\SettleApiException;
 
 /**
  * Class PaymentRequests
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
+ * @link https://api.support.settle.eu/api/reference/rest/v1/merchant.payment.request/
  */
 class PaymentRequests extends SettleApi
 {
@@ -66,16 +68,22 @@ public function outcome($payment_request_id)
      * @param string $currency
      * @param float|int $amount
      * @param float|int $additional_amount
+     * @param string $capture_id
      * @return array
+     * @throws SettleApiException
      */
-    public function capture($payment_request_id, $currency, $amount, $additional_amount = 0)
+    public function capture($payment_request_id, $currency, $amount, $additional_amount = 0, $capture_id = '')
     {
+        if (empty($capture_id)) {
+            $capture_id = 'cap_' . date('YmdHis');
+        }
+
         $data = [
             'action' => 'capture',
             'currency' => $currency,
             'amount' => $amount,
             'additional_amount' => $additional_amount,
-            'capture_id' => 'cap_' . date('YmdHis'),
+            'capture_id' => $capture_id,
         ];
 
         return $this->update($payment_request_id, $data);
@@ -87,16 +95,22 @@ public function capture($payment_request_id, $currency, $amount, $additional_amo
      * @param float $amount
      * @param float|int $additional_amount
      * @param string $message
+     * @param string $refund_id
      * @return array
+     * @throws SettleApiException
      */
-    public function refund($payment_request_id, $currency, $amount, $additional_amount = 0, $message = '')
+    public function refund($payment_request_id, $currency, $amount, $additional_amount = 0, $message = '', $refund_id = '')
     {
+        if (empty($refund_id)) {
+            $refund_id = 'ref_' . date('YmdHis');
+        }
+
         $data = [
             'action' => 'refund',
             'currency' => $currency,
             'amount' => $amount,
             'additional_amount' => $additional_amount,
-            'refund_id' => 'ref_' . date('YmdHis'),
+            'refund_id' => $refund_id,
             'text' => $message,
         ];
 
@@ -109,15 +123,16 @@ public function refund($payment_request_id, $currency, $amount, $additional_amou
      */
     public function getPaymentLink($payment_request_id)
     {
-        return $this->createLink('payment_link', compact('payment_request_id'));
+        return $this->createLink(SettleApiClient::LINK_TEMPLATE_PAYMENT, compact('payment_request_id'));
     }
 
     /**
      * @param string $payment_request_id
+     * @param array $socialData
      * @return string
      */
-    public function getMobilePaymentLink($payment_request_id)
+    public function getDynamicLink($payment_request_id, $socialData = [])
     {
-        return $this->createLink('payment_link_mobile', compact('payment_request_id'));
+        return $this->createLink(SettleApiClient::LINK_TEMPLATE_DYNAMIC, compact('payment_request_id'), $socialData);
     }
 }

src/MerchantApi/PaymentSends.php

@@ -1,13 +1,14 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
-use Danielz\SettleApi\SettleApiException;
+use SettleApi\SettleApi;
+use SettleApi\SettleApiException;
 
 /**
  * Class PaymentSends
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
+ * @link https://api.support.settle.eu/api/reference/rest/v1/merchant.payment.send/
  */
 class PaymentSends extends SettleApi
 {

src/MerchantApi/Pos.php

@@ -1,13 +1,14 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
-use Danielz\SettleApi\SettleApiException;
+use SettleApi\SettleApi;
+use SettleApi\SettleApiException;
 
 /**
  * Class Pos
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
+ * @link https://api.support.settle.eu/api/reference/rest/v1/merchant.pos/
  */
 class Pos extends SettleApi
 {

src/MerchantApi/Profile.php

@@ -1,13 +1,14 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
-use Danielz\SettleApi\SettleApiException;
+use SettleApi\SettleApi;
+use SettleApi\SettleApiException;
 
 /**
  * Class Profile
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
+ * @link https://api.support.settle.eu/api/reference/rest/v1/merchant.profile/
  */
 class Profile extends SettleApi
 {

src/MerchantApi/Settlements.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace Danielz\SettleApi\MerchantApi;
+namespace SettleApi\MerchantApi;
 
-use Danielz\SettleApi\SettleApi;
-use Danielz\SettleApi\SettleApiException;
+use SettleApi\SettleApi;
+use SettleApi\SettleApiException;
 
 /**
  * Class Settlements
- * @package Danielz\SettleApi\MerchantApi
+ * @package SettleApi\MerchantApi
  */
 class Settlements extends SettleApi
 {
@@ -33,6 +33,7 @@ public function get($settlement_id)
     /**
      * @return array
      * @throws SettleApiException
+     * @todo This endpoint isn't working properly
      */
     public function latest()
     {
@@ -42,6 +43,7 @@ public function latest()
     /**
      * @return array
      * @throws SettleApiException
+     * @todo This endpoint isn't working properly
      */
     public function report()
     {