Sdk 1955 Add support for setting instructions for In-Branch Verification (#247)

* SDK-1955 Add main logic

* SDK-1955 Add tests

Author: LuborRod

.github/workflows/tests.yaml

@@ -57,8 +57,6 @@ jobs:
 
       - run: composer test
 
-      - run: composer lint
-
   guzzle:
     name: Unit Tests With Guzzle 6 (php ${{ matrix.php-version }})
     runs-on: ubuntu-latest
@@ -87,8 +85,6 @@ jobs:
 
       - run: composer test
 
-      - run: composer lint
-
   protobuf:
     name: Unit Tests With Protobuf C Extension 3.13 (php ${{ matrix.php-version }})
     runs-on: ubuntu-latest
@@ -116,5 +112,3 @@ jobs:
 
       - run: composer test
 
-      - run: composer lint
-

src/DocScan/Constants.php

@@ -43,6 +43,8 @@ class Constants
     public const FALLBACK = 'FALLBACK';
     public const NEVER = 'NEVER';
 
+    public const UK_POST_OFFICE = "UK_POST_OFFICE";
+
     public const BASIC = 'BASIC';
     public const BEARER = 'BEARER';
 

src/DocScan/DocScanClient.php

@@ -9,6 +9,7 @@
 use Yoti\DocScan\Session\Create\FaceCapture\CreateFaceCaptureResourcePayload;
 use Yoti\DocScan\Session\Create\FaceCapture\UploadFaceCaptureImagePayload;
 use Yoti\DocScan\Session\Create\SessionSpecification;
+use Yoti\DocScan\Session\Instructions\Instructions;
 use Yoti\DocScan\Session\Retrieve\Configuration\SessionConfigurationResponse;
 use Yoti\DocScan\Session\Retrieve\GetSessionResult;
 use Yoti\DocScan\Support\SupportedDocumentsResponse;
@@ -176,4 +177,12 @@ public function getSessionConfiguration(string $sessionId): SessionConfiguration
     {
         return $this->docScanService->fetchSessionConfiguration($sessionId);
     }
+
+    /**
+     * @throws Exception\DocScanException
+     */
+    public function putIbvInstructions(string $sessionId, Instructions $instructions): void
+    {
+        $this->docScanService->putIbvInstructions($sessionId, $instructions);
+    }
 }

src/DocScan/Service.php

@@ -11,6 +11,7 @@
 use Yoti\DocScan\Session\Create\FaceCapture\CreateFaceCaptureResourcePayload;
 use Yoti\DocScan\Session\Create\FaceCapture\UploadFaceCaptureImagePayload;
 use Yoti\DocScan\Session\Create\SessionSpecification;
+use Yoti\DocScan\Session\Instructions\Instructions;
 use Yoti\DocScan\Session\Retrieve\Configuration\SessionConfigurationResponse;
 use Yoti\DocScan\Session\Retrieve\CreateFaceCaptureResourceResponse;
 use Yoti\DocScan\Session\Retrieve\GetSessionResult;
@@ -284,6 +285,25 @@ public function fetchSessionConfiguration(string $sessionId): SessionConfigurati
         return new SessionConfigurationResponse($result);
     }
 
+    /**
+     * @param string $sessionId
+     * @param Instructions $instructions
+     * @throws DocScanException
+     */
+    public function putIbvInstructions(string $sessionId, Instructions $instructions): void
+    {
+        $response = (new RequestBuilder($this->config))
+            ->withBaseUrl($this->apiUrl)
+            ->withPemFile($this->pemFile)
+            ->withEndpoint(sprintf('/sessions/%s/instructions', $sessionId))
+            ->withPut()
+            ->withPayload(Payload::fromJsonData($instructions))
+            ->build()
+            ->execute();
+
+        self::assertResponseIsSuccess($response);
+    }
+
     /**
      * @param ResponseInterface $response
      *

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

@@ -0,0 +1,27 @@
+<?php
+
+namespace Yoti\DocScan\Session\Instructions\Branch;
+
+abstract class Branch
+{
+    /**
+     * @var string
+     */
+    private $type;
+
+    /**
+     * @param string $type
+     */
+    public function __construct(string $type)
+    {
+        $this->type = $type;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+}

src/DocScan/Session/Instructions/Branch/Location.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Yoti\DocScan\Session\Instructions\Branch;
+
+class Location
+{
+    /**
+     * @var float
+     */
+    private $latitude;
+
+    /**
+     * @var float
+     */
+    private $longitude;
+
+    /**
+     * @param float $longitude
+     * @param float $latitude
+     */
+    public function __construct(float $latitude, float $longitude)
+    {
+        $this->latitude = $latitude;
+        $this->longitude = $longitude;
+    }
+
+    /**
+     * @return float
+     */
+    public function getLatitude(): float
+    {
+        return $this->latitude;
+    }
+
+    /**
+     * @return float
+     */
+    public function getLongitude(): float
+    {
+        return $this->longitude;
+    }
+}

src/DocScan/Session/Instructions/Branch/LocationBuilder.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Yoti\DocScan\Session\Instructions\Branch;
+
+class LocationBuilder
+{
+    /**
+     * @var float
+     */
+    private $latitude;
+
+    /**
+     * @var float
+     */
+    private $longitude;
+
+    /**
+     * Sets the latitude of the location, in decimal degrees (e.g. -40.3992)
+     *
+     * @param float $latitude
+     * @return $this
+     */
+    public function withLatitude(float $latitude): LocationBuilder
+    {
+        $this->latitude = $latitude;
+        return $this;
+    }
+
+    /**
+     * Sets the longitude of the location, in decimal degrees (e.g. 20.4821)
+     *
+     * @param float $longitude
+     * @return $this
+     */
+    public function withLongitude(float $longitude): LocationBuilder
+    {
+        $this->longitude = $longitude;
+        return $this;
+    }
+
+    /**
+     * @return Location
+     */
+    public function build(): Location
+    {
+        return new Location($this->latitude, $this->longitude);
+    }
+}

src/DocScan/Session/Instructions/Branch/UkPostOfficeBranch.php

@@ -0,0 +1,98 @@
+<?php
+
+namespace Yoti\DocScan\Session\Instructions\Branch;
+
+use Yoti\DocScan\Constants;
+
+class UkPostOfficeBranch extends Branch
+{
+    /**
+     * @var string|null
+     */
+    private $name;
+
+    /**
+     * @var string|null
+     */
+    private $address;
+
+    /**
+     * @var string|null
+     */
+    private $postCode;
+
+    /**
+     * @var string|null
+     */
+    private $fadCode;
+
+    /**
+     * @var Location|null
+     */
+    private $location;
+
+    public function __construct(
+        ?string $name,
+        ?string $address,
+        ?string $postCode,
+        ?string $fadCode = null,
+        ?Location $location = null
+    ) {
+        parent::__construct(Constants::UK_POST_OFFICE);
+        $this->name = $name;
+        $this->address = $address;
+        $this->postCode = $postCode;
+        $this->fadCode = $fadCode;
+        $this->location = $location;
+    }
+
+    /**
+     * Returns the FAD code that has been set for the {@link UkPostOfficeBranch}
+     *
+     * @return string|null
+     */
+    public function getFadCode(): ?string
+    {
+        return $this->fadCode;
+    }
+
+    /**
+     * Returns the name that has been set for the {@link UkPostOfficeBranch}
+     *
+     * @return string|null
+     */
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    /**
+     * Returns the address that has been set for the {@link UkPostOfficeBranch}
+     *
+     * @return string|null
+     */
+    public function getAddress(): ?string
+    {
+        return $this->address;
+    }
+
+    /**
+     * Returns the post code that has been set for the {@link UkPostOfficeBranch}
+     *
+     * @return string|null
+     */
+    public function getPostCode(): ?string
+    {
+        return $this->postCode;
+    }
+
+    /**
+     * Returns the {@link Location} that has been set for the {@link UkPostOfficeBranch}
+     *
+     * @return Location|null
+     */
+    public function getLocation(): ?Location
+    {
+        return $this->location;
+    }
+}

src/DocScan/Session/Instructions/Branch/UkPostOfficeBranchBuilder.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Yoti\DocScan\Session\Instructions\Branch;
+
+class UkPostOfficeBranchBuilder
+{
+    /**
+     * @var string|null
+     */
+    private $name;
+
+    /**
+     * @var string|null
+     */
+    private $address;
+
+    /**
+     * @var string|null
+     */
+    private $postCode;
+
+    /**
+     * @var string|null
+     */
+    private $fadCode;
+
+    /**
+     * @var Location|null
+     */
+    private $location;
+
+    /**
+     * @param string $name
+     * @return $this
+     */
+    public function withName(string $name): UkPostOfficeBranchBuilder
+    {
+        $this->name = $name;
+        return $this;
+    }
+
+    /**
+     * @param string $address
+     * @return $this
+     */
+    public function withAddress(string $address): UkPostOfficeBranchBuilder
+    {
+        $this->address = $address;
+        return $this;
+    }
+
+    /**
+     * @param string $postCode
+     * @return $this
+     */
+    public function withPostCode(string $postCode): UkPostOfficeBranchBuilder
+    {
+        $this->postCode = $postCode;
+        return $this;
+    }
+
+    /**
+     * @param string $fadCode
+     * @return $this
+     */
+    public function withFadCode(string $fadCode): UkPostOfficeBranchBuilder
+    {
+        $this->fadCode = $fadCode;
+        return $this;
+    }
+
+    /**
+     * @param Location $location
+     * @return $this
+     */
+    public function withLocation(Location $location): UkPostOfficeBranchBuilder
+    {
+        $this->location = $location;
+        return $this;
+    }
+
+    /**
+     * @return UkPostOfficeBranch
+     */
+    public function build(): UkPostOfficeBranch
+    {
+        return new UkPostOfficeBranch($this->name, $this->address, $this->postCode, $this->fadCode, $this->location);
+    }
+}