SDK-1744: Add support for biometric consent

Author: davidgrayston

src/DocScan/Session/Create/SessionSpecification.php

@@ -8,10 +8,10 @@
 use Yoti\DocScan\Session\Create\Check\RequestedCheck;
 use Yoti\DocScan\Session\Create\Filters\RequiredDocument;
 use Yoti\DocScan\Session\Create\Task\RequestedTask;
+use Yoti\Util\Json;
 
 class SessionSpecification implements JsonSerializable
 {
-
     /**
      * @var int|null
      */
@@ -52,6 +52,11 @@ class SessionSpecification implements JsonSerializable
      */
     private $sdkConfig;
 
+    /**
+     * @var bool|null
+     */
+    private $blockBiometricConsent;
+
     /**
      * SessionSpecification constructor.
      * @param int|null $clientSessionTokenTtl
@@ -62,6 +67,7 @@ class SessionSpecification implements JsonSerializable
      * @param RequestedTask[] $requestedTasks
      * @param SdkConfig|null $sdkConfig
      * @param RequiredDocument[] $requiredDocuments
+     * @param bool|null $blockBiometricConsent
      */
     public function __construct(
         ?int $clientSessionTokenTtl,
@@ -71,7 +77,8 @@ public function __construct(
         array $requestedChecks,
         array $requestedTasks,
         ?SdkConfig $sdkConfig,
-        array $requiredDocuments = []
+        array $requiredDocuments = [],
+        ?bool $blockBiometricConsent = null
     ) {
         $this->clientSessionTokenTtl = $clientSessionTokenTtl;
         $this->resourcesTtl = $resourcesTtl;
@@ -81,14 +88,15 @@ public function __construct(
         $this->requestedTasks = $requestedTasks;
         $this->sdkConfig = $sdkConfig;
         $this->requiredDocuments = $requiredDocuments;
+        $this->blockBiometricConsent = $blockBiometricConsent;
     }
 
     /**
      * @return array<string, mixed>
      */
     public function jsonSerialize(): array
     {
-        return [
+        return Json::withoutNullValues([
             'client_session_token_ttl' => $this->getClientSessionTokenTtl(),
             'resources_ttl' => $this->getResourcesTtl(),
             'user_tracking_id' => $this->getUserTrackingId(),
@@ -97,7 +105,8 @@ public function jsonSerialize(): array
             'requested_tasks' => $this->getRequestedTasks(),
             'sdk_config' => $this->getSdkConfig(),
             'required_documents' => $this->getRequiredDocuments(),
-        ];
+            'block_biometric_consent' => $this->getBlockBiometricConsent(),
+        ]);
     }
 
     /**
@@ -163,4 +172,14 @@ public function getRequiredDocuments(): array
     {
         return $this->requiredDocuments;
     }
+
+    /**
+     * Whether or not to block the collection of biometric consent
+     *
+     * @return bool|null
+     */
+    public function getBlockBiometricConsent(): ?bool
+    {
+        return $this->blockBiometricConsent;
+    }
 }

src/DocScan/Session/Create/SessionSpecificationBuilder.php

@@ -51,6 +51,11 @@ class SessionSpecificationBuilder
      */
     private $requiredDocuments = [];
 
+    /**
+     * @var bool|null
+     */
+    private $blockBiometricConsent;
+
     /**
      * @param int $clientSessionTokenTtl
      * @return $this
@@ -154,6 +159,19 @@ public function withRequiredDocument(RequiredDocument $requiredDocument): self
         return $this;
     }
 
+    /**
+     * Sets whether or not to block the collection of biometric consent
+     *
+     * @param bool $blockBiometricConsent
+     *
+     * @return $this
+     */
+    public function withBlockBiometricConsent(bool $blockBiometricConsent): self
+    {
+        $this->blockBiometricConsent = $blockBiometricConsent;
+        return $this;
+    }
+
     /**
      * @return SessionSpecification
      */
@@ -167,7 +185,8 @@ public function build(): SessionSpecification
             $this->requestedChecks,
             $this->requestedTasks,
             $this->sdkConfig,
-            $this->requiredDocuments
+            $this->requiredDocuments,
+            $this->blockBiometricConsent
         );
     }
 }

src/DocScan/Session/Retrieve/GetSessionResult.php

@@ -5,6 +5,7 @@
 namespace Yoti\DocScan\Session\Retrieve;
 
 use Yoti\DocScan\Constants;
+use Yoti\Util\DateTime;
 
 class GetSessionResult
 {
@@ -44,6 +45,11 @@ class GetSessionResult
      */
     private $clientSessionTokenTtl;
 
+    /**
+     * @var \DateTime
+     */
+    private $biometricConsent;
+
     /**
      * DocScanSession constructor.
      * @param array<string, mixed> $sessionData
@@ -56,6 +62,10 @@ public function __construct(array $sessionData)
         $this->clientSessionToken = $sessionData['client_session_token'] ?? null;
         $this->clientSessionTokenTtl = $sessionData['client_session_token_ttl'] ?? null;
 
+        if (isset($sessionData['biometric_consent'])) {
+            $this->biometricConsent = DateTime::stringToDateTime($sessionData['biometric_consent']);
+        }
+
         if (isset($sessionData['checks'])) {
             foreach ($sessionData['checks'] as $check) {
                 $this->checks[] = $this->createCheckFromArray($check);
@@ -123,6 +133,14 @@ public function getClientSessionTokenTtl(): ?int
         return $this->clientSessionTokenTtl;
     }
 
+    /**
+     * @return \DateTime|null
+     */
+    public function getBiometricConsentTimestamp(): ?\DateTime
+    {
+        return $this->biometricConsent;
+    }
+
     /**
      * @return AuthenticityCheckResponse[]
      */