clean up, add docblocks

mortenebak · Sep 3, 2024 · a264e15 · a264e15
1 parent f7f66e8
commit a264e15
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 60 deletions.
diff --git a/src/Commands/QuickpayCommand.php b/src/Commands/QuickpayCommand.php
diff --git a/src/Facades/Quickpay.php b/src/Facades/Quickpay.php
@@ -3,18 +3,12 @@
 namespace Netbums\Quickpay\Facades;
 
 use Illuminate\Support\Facades\Facade;
-use Netbums\Quickpay\Resources\CardResource;
-use Netbums\Quickpay\Resources\FeeResource;
 use Netbums\Quickpay\Resources\PaymentResource;
-use Netbums\Quickpay\Resources\PayoutResource;
 use Netbums\Quickpay\Resources\SubscriptionResource;
 
 /**
  * @method static PaymentResource payments();
  * @method static SubscriptionResource subscriptions();
- * @method static CardResource cards();
- * @method static FeeResource fees();
- * @method static PayoutResource payouts();
  */
 class Quickpay extends Facade
 {

diff --git a/src/Resources/Concerns/QuickpayApiConsumer.php b/src/Resources/Concerns/QuickpayApiConsumer.php
@@ -17,6 +17,11 @@ trait QuickpayApiConsumer
     public function __construct(public QuickPay $client) {}
 
     /**
+     * Make a request to the Quickpay API
+     * @param string $method
+     * @param string $endpoint
+     * @param array $data
+     * @return array
      * @throws CardNotAccepted
      * @throws QuickPayValidationError
      */

diff --git a/src/Resources/PaymentResource.php b/src/Resources/PaymentResource.php
@@ -24,6 +24,8 @@ class PaymentResource
     use QuickpayApiConsumer;
 
     /**
+     * Fetch all payments
+     * @return array
      * @throws FetchPaymentsFailed
      */
     public function all(): array
@@ -45,6 +47,9 @@ public function all(): array
     }
 
     /**
+     * Create Payment
+     * @param Payment $payment
+     * @return array
      * @throws CreatePaymentFailed
      */
     public function create(Payment $payment): array
@@ -67,7 +72,8 @@ public function create(Payment $payment): array
 
     /**
      * Create or Update the Payment Link
-     *
+     * @param PaymentLink $paymentLink
+     * @return array
      * @throws CreatePaymentLinkFailed
      */
     public function createLink(PaymentLink $paymentLink): array
@@ -92,7 +98,8 @@ public function createLink(PaymentLink $paymentLink): array
 
     /**
      * Delete payment link
-     *
+     * @param int $id
+     * @return array
      * @throws DeletePaymentLinkFailed
      */
     public function deleteLink(int $id): array
@@ -115,7 +122,8 @@ public function deleteLink(int $id): array
 
     /**
      * Get Payment
-     *
+     * @param int $id
+     * @return array
      * @throws FetchPaymentFailed
      */
     public function find(int $id): array
@@ -138,7 +146,9 @@ public function find(int $id): array
 
     /**
      * Create payment session
-     *
+     * @param int $id
+     * @param int $amount
+     * @return array
      * @throws CreatePaymentSessionFailed
      */
     public function createPaymentSession(int $id, int $amount): array
@@ -166,7 +176,9 @@ public function createPaymentSession(int $id, int $amount): array
 
     /**
      * authorize payment
-     *
+     * @param int $id
+     * @param int $amount
+     * @return array
      * @throws AuthorizePaymentFailed
      */
     public function authorize(int $id, int $amount): array
@@ -194,7 +206,9 @@ public function authorize(int $id, int $amount): array
 
     /**
      * capture payment
-     *
+     * @param int $id
+     * @param int $amount
+     * @return array
      * @throws CapturePaymentFailed
      */
     public function capture(int $id, int $amount): array
@@ -222,7 +236,9 @@ public function capture(int $id, int $amount): array
 
     /**
      * refund payment
-     *
+     * @param int $id
+     * @param int $amount
+     * @return array
      * @throws RefundPaymentFailed
      */
     public function refund(int $id, int $amount): array
@@ -251,7 +267,8 @@ public function refund(int $id, int $amount): array
 
     /**
      * cancel payment
-     *
+     * @param int $id
+     * @return array
      * @throws CancelPaymentFailed
      */
     public function cancel(int $id): array
@@ -274,7 +291,8 @@ public function cancel(int $id): array
 
     /**
      * renew authorization
-     *
+     * @param int $id
+     * @return array
      * @throws RenewPaymentFailed
      */
     public function renew(int $id): array
@@ -297,7 +315,9 @@ public function renew(int $id): array
 
     /**
      * create fraud confirmation report
-     *
+     * @param int $id
+     * @param string|null $description
+     * @return array
      * @throws CreateFraudConfirmationReportFailed
      */
     public function createFraudConfirmationReport(int $id, ?string $description = null): array
@@ -321,29 +341,4 @@ public function createFraudConfirmationReport(int $id, ?string $description = nu
 
         return $response;
     }
-
-    //    /** Helpers for the createLink() */
-    //    public function allowedPaymentMethods(string $paymentMethods): static
-    //    {
-    //        $this->data['payment_methods'] = $paymentMethods;
-    //        return $this;
-    //    }
-    //
-    //    public function autoFee(): static
-    //    {
-    //        $this->data['auto_fee'] = true;
-    //        return $this;
-    //    }
-    //
-    //    public function acquirer(string $aquirer): static
-    //    {
-    //        $this->data['acquirer'] = $aquirer;
-    //        return $this;
-    //    }
-    //
-    //    public function autoCapture(): static
-    //    {
-    //        $this->data['auto_capture'] = true;
-    //        return $this;
-    //    }
 }
diff --git a/src/Resources/SubscriptionResource.php b/src/Resources/SubscriptionResource.php
@@ -2,6 +2,8 @@
 
 namespace Netbums\Quickpay\Resources;
 
+use Netbums\Quickpay\Exceptions\QuickPayValidationError;
+use Netbums\Quickpay\Exceptions\Subscriptions\FetchSubscriptionFailed;
 use Netbums\Quickpay\Exceptions\Subscriptions\FetchSubscriptionsFailed;
 use Netbums\Quickpay\Resources\Concerns\QuickpayApiConsumer;
 use Throwable;
@@ -68,6 +70,9 @@ public function deletePaymentLink(string $subscriptionId): array
 
     // @see https://learn.quickpay.net/tech-talk/api/services/#POST-subscriptions---format-
     // TODO: convert the provided array to a DTO
+    /**
+     * @throws QuickPayValidationError
+     */
     public function create(array $data): array
     {
         $this->method = 'post';