Sdk 1956 Allow Relying Business to fetch IBV Instructions (#251)

* SDK-1956 Add main logic

* SDK-1956 Add several tests

* SDK-1956 Add more tests

* SDK-1956 Add last tests

Co-authored-by: Rodion Liuborets <[email protected]>

Author: LuborRod

src/DocScan/DocScanClient.php

@@ -12,6 +12,7 @@
 use Yoti\DocScan\Session\Instructions\Instructions;
 use Yoti\DocScan\Session\Retrieve\Configuration\SessionConfigurationResponse;
 use Yoti\DocScan\Session\Retrieve\GetSessionResult;
+use Yoti\DocScan\Session\Retrieve\Instructions\InstructionsResponse;
 use Yoti\DocScan\Support\SupportedDocumentsResponse;
 use Yoti\Media\Media;
 use Yoti\Util\Config;
@@ -193,4 +194,14 @@ public function putIbvInstructions(string $sessionId, Instructions $instructions
     {
         $this->docScanService->putIbvInstructions($sessionId, $instructions);
     }
+
+    /**
+     * @param string $sessionId
+     * @return InstructionsResponse
+     * @throws Exception\DocScanException
+     */
+    public function getIbvInstructions(string $sessionId): InstructionsResponse
+    {
+        return $this->docScanService->getIbvInstructions($sessionId);
+    }
 }

src/DocScan/Service.php

@@ -15,6 +15,7 @@
 use Yoti\DocScan\Session\Retrieve\Configuration\SessionConfigurationResponse;
 use Yoti\DocScan\Session\Retrieve\CreateFaceCaptureResourceResponse;
 use Yoti\DocScan\Session\Retrieve\GetSessionResult;
+use Yoti\DocScan\Session\Retrieve\Instructions\InstructionsResponse;
 use Yoti\DocScan\Support\SupportedDocumentsResponse;
 use Yoti\Http\Payload;
 use Yoti\Http\Request;
@@ -309,6 +310,28 @@ public function putIbvInstructions(string $sessionId, Instructions $instructions
         self::assertResponseIsSuccess($response);
     }
 
+    /**
+     * @param string $sessionId
+     * @return InstructionsResponse
+     * @throws DocScanException
+     */
+    public function getIbvInstructions(string $sessionId): InstructionsResponse
+    {
+        $response = (new RequestBuilder($this->config))
+            ->withBaseUrl($this->apiUrl)
+            ->withPemFile($this->pemFile)
+            ->withEndpoint(sprintf('/sessions/%s/instructions', $sessionId))
+            ->withGet()
+            ->build()
+            ->execute();
+
+        self::assertResponseIsSuccess($response);
+
+        $result = Json::decode((string)$response->getBody());
+
+        return new InstructionsResponse($result);
+    }
+
     /**
      * @param ResponseInterface $response
      *

src/DocScan/Session/Retrieve/Instructions/Branch/BranchResponse.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\Instructions\Branch;
+
+class BranchResponse
+{
+    /**
+     * @var string
+     */
+    protected $type;
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+}

src/DocScan/Session/Retrieve/Instructions/Branch/LocationResponse.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\Instructions\Branch;
+
+class LocationResponse
+{
+    /**
+     * @var float
+     */
+    private $latitude;
+
+    /**
+     * @var float
+     */
+    private $longitude;
+
+    /**
+     * @param array<string, float> $locationData
+     */
+    public function __construct(array $locationData)
+    {
+        $this->latitude = $locationData['latitude'];
+        $this->longitude = $locationData['longitude'];
+    }
+
+    /**
+     * @return float
+     */
+    public function getLatitude(): float
+    {
+        return $this->latitude;
+    }
+
+    /**
+     * @return float
+     */
+    public function getLongitude(): float
+    {
+        return $this->longitude;
+    }
+}

src/DocScan/Session/Retrieve/Instructions/Branch/UkPostOfficeBranchResponse.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\Instructions\Branch;
+
+class UkPostOfficeBranchResponse extends BranchResponse
+{
+    /**
+     * @var string|null
+     */
+    private $name;
+
+    /**
+     * @var string|null
+     */
+    private $address;
+
+    /**
+     * @var string|null
+     */
+    private $postCode;
+
+    /**
+     * @var string|null
+     */
+    private $fadCode;
+
+    /**
+     * @var LocationResponse|null
+     */
+    private $location;
+
+    /**
+     * @param array<string, mixed> $branchData
+     */
+    public function __construct(array $branchData)
+    {
+        $this->type = $branchData['type'];
+        $this->fadCode = $branchData['fad_code'];
+        $this->name = $branchData['name'];
+        $this->address = $branchData['address'];
+        $this->postCode = $branchData['post_code'];
+        $this->location = new LocationResponse($branchData['location']);
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getAddress(): ?string
+    {
+        return $this->address;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getPostCode(): ?string
+    {
+        return $this->postCode;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getFadCode(): ?string
+    {
+        return $this->fadCode;
+    }
+
+    /**
+     * @return LocationResponse
+     */
+    public function getLocation(): ?LocationResponse
+    {
+        return $this->location;
+    }
+}

src/DocScan/Session/Retrieve/Instructions/Document/DocumentProposalResponse.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\Instructions\Document;
+
+use Yoti\DocScan\Constants;
+
+class DocumentProposalResponse
+{
+    /**
+     * @var string|null
+     */
+    private $requirementId;
+
+    /**
+     * @var SelectedDocumentResponse|null
+     */
+    private $document;
+
+    /**
+     * @param array<string, mixed> $documentData
+     */
+    public function __construct(array $documentData)
+    {
+        $this->requirementId = $documentData['requirement_id'];
+        switch ($documentData['document']['type']) {
+            case Constants::ID_DOCUMENT:
+                $this->document = new SelectedIdDocumentResponse($documentData['document']);
+                break;
+            case Constants::SUPPLEMENTARY_DOCUMENT:
+                $this->document = new SelectedSupplementaryDocumentResponse($documentData['document']);
+                break;
+        }
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getRequirementId(): ?string
+    {
+        return $this->requirementId;
+    }
+
+    /**
+     * @return SelectedDocumentResponse|null
+     */
+    public function getDocument(): ?SelectedDocumentResponse
+    {
+        return $this->document;
+    }
+}

src/DocScan/Session/Retrieve/Instructions/Document/SelectedDocumentResponse.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\Instructions\Document;
+
+abstract class SelectedDocumentResponse
+{
+    /**
+     * @var string
+     */
+    private $type;
+
+    /**
+     * @var string|null
+     */
+    private $countryCode;
+
+    /**
+     * @var string|null
+     */
+    private $documentType;
+
+    /**
+     * @param array<string, string> $document
+     */
+    public function __construct(array $document)
+    {
+        $this->type = $document['type'];
+        $this->countryCode = $document['country_code'];
+        $this->documentType = $document['document_type'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCountryCode(): ?string
+    {
+        return $this->countryCode;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getDocumentType(): ?string
+    {
+        return $this->documentType;
+    }
+}

src/DocScan/Session/Retrieve/Instructions/Document/SelectedIdDocumentResponse.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\Instructions\Document;
+
+class SelectedIdDocumentResponse extends SelectedDocumentResponse
+{
+}

src/DocScan/Session/Retrieve/Instructions/Document/SelectedSupplementaryDocumentResponse.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve\Instructions\Document;
+
+class SelectedSupplementaryDocumentResponse extends SelectedDocumentResponse
+{
+}