update doc contracts

Author: rez1dent3

src/Interfaces/Customer.php

@@ -8,6 +8,7 @@
 use Bavix\Wallet\Exceptions\InsufficientFunds;
 use Bavix\Wallet\Exceptions\ProductEnded;
 use Bavix\Wallet\Internal\Exceptions\ExceptionInterface;
+use Bavix\Wallet\Internal\Exceptions\ModelNotFoundException;
 use Bavix\Wallet\Internal\Exceptions\TransactionFailedException;
 use Bavix\Wallet\Models\Transfer;
 use Illuminate\Database\RecordsNotFoundException;
@@ -36,7 +37,7 @@ public function forceRefund(Product $product, bool $gifts = false): bool;
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      *
-     * @return Transfer[]
+     * @return non-empty-array<Transfer>
      */
     public function payFreeCart(CartInterface $cart): array;
 
@@ -48,23 +49,58 @@ public function payFreeCart(CartInterface $cart): array;
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      *
-     * @return Transfer[]
+     * @return non-empty-array<Transfer>
      */
     public function payCart(CartInterface $cart, bool $force = false): array;
 
-    /**
-     * @return Transfer[]
-     */
+    /** @return Transfer[] */
     public function safePayCart(CartInterface $cart, bool $force = false): array;
 
     /**
-     * @return Transfer[]
+     * @throws ProductEnded
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ExceptionInterface
+     *
+     * @return non-empty-array<Transfer>
      */
     public function forcePayCart(CartInterface $cart): array;
 
+    /**
+     * @throws BalanceIsEmpty
+     * @throws InsufficientFunds
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
     public function refundCart(CartInterface $cart, bool $force = false, bool $gifts = false): bool;
 
     public function safeRefundCart(CartInterface $cart, bool $force = false, bool $gifts = false): bool;
 
+    /**
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
     public function forceRefundCart(CartInterface $cart, bool $gifts = false): bool;
+
+    /**
+     * @throws BalanceIsEmpty
+     * @throws InsufficientFunds
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
+    public function refundGiftCart(CartInterface $cart, bool $force = false): bool;
+
+    /**
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
+    public function forceRefundGiftCart(CartInterface $cart): bool;
 }

src/Traits/CartPay.php

@@ -72,9 +72,7 @@ public function payFreeCart(CartInterface $cart): array
         });
     }
 
-    /**
-     * @return Transfer[]
-     */
+    /** @return Transfer[] */
     public function safePayCart(CartInterface $cart, bool $force = false): array
     {
         try {
@@ -128,6 +126,11 @@ public function payCart(CartInterface $cart, bool $force = false): array
     }
 
     /**
+     * @throws ProductEnded
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ExceptionInterface
+     *
      * @return non-empty-array<Transfer>
      */
     public function forcePayCart(CartInterface $cart): array
@@ -144,6 +147,14 @@ public function safeRefundCart(CartInterface $cart, bool $force = false, bool $g
         }
     }
 
+    /**
+     * @throws BalanceIsEmpty
+     * @throws InsufficientFunds
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
     public function refundCart(CartInterface $cart, bool $force = false, bool $gifts = false): bool
     {
         return app(DatabaseServiceInterface::class)->transaction(function () use ($cart, $force, $gifts) {
@@ -194,6 +205,12 @@ public function refundCart(CartInterface $cart, bool $force = false, bool $gifts
         });
     }
 
+    /**
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
     public function forceRefundCart(CartInterface $cart, bool $gifts = false): bool
     {
         return $this->refundCart($cart, true, $gifts);
@@ -208,11 +225,25 @@ public function safeRefundGiftCart(CartInterface $cart, bool $force = false): bo
         }
     }
 
+    /**
+     * @throws BalanceIsEmpty
+     * @throws InsufficientFunds
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
     public function refundGiftCart(CartInterface $cart, bool $force = false): bool
     {
         return $this->refundCart($cart, $force, true);
     }
 
+    /**
+     * @throws RecordsNotFoundException
+     * @throws TransactionFailedException
+     * @throws ModelNotFoundException
+     * @throws ExceptionInterface
+     */
     public function forceRefundGiftCart(CartInterface $cart): bool
     {
         return $this->refundGiftCart($cart, true);