FN-14504 Added GetCreditors request/response classes and getCreditors method to retrieve available creditors grouped by product type.

Author: akozubskicr

src/Api/Client.php

@@ -18,6 +18,7 @@
 use Comfino\Api\Request\GetOrder as GetOrderRequest;
 use Comfino\Api\Request\GetPaywall as GetPaywallRequest;
 use Comfino\Api\Request\GetPaywallItemDetails as GetPaywallItemDetailsRequest;
+use Comfino\Api\Request\GetCreditors as GetCreditorsRequest;
 use Comfino\Api\Request\GetProductTypes as GetProductTypesRequest;
 use Comfino\Api\Request\GetWidgetKey as GetWidgetKeyRequest;
 use Comfino\Api\Request\GetWidgetTypes as GetWidgetTypesRequest;
@@ -29,6 +30,7 @@
 use Comfino\Api\Response\GetOrder as GetOrderResponse;
 use Comfino\Api\Response\GetPaywall as GetPaywallResponse;
 use Comfino\Api\Response\GetPaywallItemDetails as GetPaywallItemDetailsResponse;
+use Comfino\Api\Response\GetCreditors as GetCreditorsResponse;
 use Comfino\Api\Response\GetProductTypes as GetProductTypesResponse;
 use Comfino\Api\Response\GetWidgetKey as GetWidgetKeyResponse;
 use Comfino\Api\Response\GetWidgetTypes as GetWidgetTypesResponse;
@@ -390,7 +392,7 @@ public function validateOrder(OrderInterface $order): ValidateOrderResponse
     }
 
     /**
-     * Returns a details of specified loan application.
+     * Returns details of a specified loan application.
      *
      * @param string $orderId Loan application ID returned by createOrder action.
      *
@@ -445,6 +447,23 @@ public function getProductTypes(ProductTypesListTypeEnum $listType): GetProductT
         return new GetProductTypesResponse($this->request, $this->sendRequest($this->request), $this->serializer);
     }
 
+    /**
+     * Returns a map of available creditors grouped by product type for an authorized shop account.
+     *
+     * @throws RequestValidationError
+     * @throws ResponseValidationError
+     * @throws AuthorizationError
+     * @throws AccessDenied
+     * @throws ServiceUnavailable
+     * @throws ClientExceptionInterface
+     */
+    public function getCreditors(): GetCreditorsResponse
+    {
+        $this->request = (new GetCreditorsRequest())->setSerializer($this->serializer);
+
+        return new GetCreditorsResponse($this->request, $this->sendRequest($this->request), $this->serializer);
+    }
+
     /**
      * Returns a widget key associated with an authorized shop account.
      *

src/Api/Request/GetCreditors.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Comfino\Api\Request;
+
+use Comfino\Api\Request;
+
+/**
+ * Available creditors list request.
+ */
+class GetCreditors extends Request
+{
+    public function __construct()
+    {
+        $this->setRequestMethod('GET');
+        $this->setApiEndpointPath('creditors');
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function prepareRequestBody(): ?array
+    {
+        return null;
+    }
+}

src/Api/Response/GetCreditors.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Comfino\Api\Response;
+
+/**
+ * Available creditors list response.
+ */
+class GetCreditors extends Base
+{
+    /** @var array<string, string[]> */
+    public readonly array $creditors;
+
+    /**
+     * @inheritDoc
+     */
+    protected function processResponseBody(array|string|bool|null|float|int $deserializedResponseBody): void
+    {
+        $this->checkResponseType($deserializedResponseBody, 'array');
+
+        $this->creditors = $deserializedResponseBody;
+    }
+}