Merge pull request #254 from getyoti/release/3.8.0

Release/3.8.0

Author: LuborRod

src/DocScan/Constants.php

@@ -22,6 +22,9 @@ class Constants
     public const FUZZY = 'FUZZY';
     public const FACE_CAPTURE = 'FACE_CAPTURE';
 
+    public const MANDATORY = "MANDATORY";
+    public const NOT_ALLOWED = "NOT_ALLOWED";
+
 
     public const ADVERSE_MEDIA = 'ADVERSE-MEDIA';
     public const SANCTIONS = 'SANCTIONS';
@@ -40,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;
@@ -29,7 +30,6 @@
  */
 class DocScanClient
 {
-
     /**
      * @var Service
      */
@@ -131,14 +131,19 @@ public function deleteMediaContent(string $sessionId, string $mediaId): void
     /**
      * Gets a list of supported documents.
      *
+     * @param bool $isStrictlyLatin
      * @return SupportedDocumentsResponse
+     * @throws Exception\DocScanException
      */
-    public function getSupportedDocuments(): SupportedDocumentsResponse
+    public function getSupportedDocuments(bool $isStrictlyLatin = false): SupportedDocumentsResponse
     {
-        return $this->docScanService->getSupportedDocuments();
+        return $this->docScanService->getSupportedDocuments($isStrictlyLatin);
     }
 
     /**
+     * Creates a Face Capture resource, that will be linked using
+     * the supplied requirement ID
+     *
      * @param string $sessionId
      * @param CreateFaceCaptureResourcePayload $createFaceCaptureResourcePayload
      * @return Session\Retrieve\CreateFaceCaptureResourceResponse
@@ -152,6 +157,8 @@ public function createFaceCaptureResource(
     }
 
     /**
+     * Uploads an image to the specified Face Capture resource
+     *
      * @param string $sessionId
      * @param string $resourceId
      * @param UploadFaceCaptureImagePayload $uploadFaceCaptureImagePayload
@@ -176,4 +183,14 @@ public function getSessionConfiguration(string $sessionId): SessionConfiguration
     {
         return $this->docScanService->fetchSessionConfiguration($sessionId);
     }
+
+    /**
+     * Sets the IBV instructions for the given session
+     *
+     * @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;
@@ -25,7 +26,6 @@
 
 class Service
 {
-
     /**
      * @var string
      */
@@ -185,17 +185,23 @@ public function deleteMediaContent(string $sessionId, string $mediaId): void
     }
 
     /**
-     * Gets a list of supported documents.
-     *
+     * @param bool $isStrictlyLatin
      * @return SupportedDocumentsResponse
+     * @throws DocScanException
      */
-    public function getSupportedDocuments(): SupportedDocumentsResponse
+    public function getSupportedDocuments(bool $isStrictlyLatin): SupportedDocumentsResponse
     {
-        $response = (new RequestBuilder($this->config))
+        $requestBuilder = (new RequestBuilder($this->config))
             ->withBaseUrl($this->apiUrl)
             ->withEndpoint('/supported-documents')
             ->withPemFile($this->pemFile)
-            ->withGet()
+            ->withGet();
+
+        if ($isStrictlyLatin) {
+            $requestBuilder->withQueryParam('includeNonLatin', '1');
+        }
+
+        $response = $requestBuilder
             ->build()
             ->execute();
 
@@ -284,6 +290,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/Create/Check/Contracts/Advanced/RequestedCaMatchingStrategy.php

@@ -6,5 +6,4 @@
 
 abstract class RequestedCaMatchingStrategy
 {
-
 }

src/DocScan/Session/Create/Check/Contracts/Advanced/RequestedCaSources.php

@@ -6,5 +6,4 @@
 
 abstract class RequestedCaSources
 {
-
 }

src/DocScan/Session/Create/Check/Contracts/RequestedWatchlistAdvancedCaConfigBuilder.php

@@ -9,7 +9,6 @@
 
 abstract class RequestedWatchlistAdvancedCaConfigBuilder
 {
-
     /**
      * @var bool
      */

src/DocScan/Session/Create/Check/RequestedCheck.php

@@ -9,7 +9,6 @@
 
 abstract class RequestedCheck implements JsonSerializable
 {
-
     /**
      * @return array<string, mixed>
      */

src/DocScan/Session/Create/Check/RequestedCheckConfigInterface.php

@@ -8,5 +8,4 @@
 
 interface RequestedCheckConfigInterface extends JsonSerializable
 {
-
 }

src/DocScan/Session/Create/Check/RequestedFaceMatchCheck.php

@@ -8,7 +8,6 @@
 
 class RequestedFaceMatchCheck extends RequestedCheck
 {
-
     /**
      * @var RequestedFaceMatchCheckConfig
      */

src/DocScan/Session/Create/Check/RequestedFaceMatchCheckConfig.php

@@ -6,7 +6,6 @@
 
 class RequestedFaceMatchCheckConfig implements RequestedCheckConfigInterface
 {
-
     /**
      * @var string
      */