Add SHARE_CODE resource type support for session creation and retrieval

src/DocScan/Constants.php

@@ -33,6 +33,7 @@ class Constants
 
     public const ID_DOCUMENT_TEXT_DATA_EXTRACTION = 'ID_DOCUMENT_TEXT_DATA_EXTRACTION';
     public const SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION = 'SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION';
+    public const VERIFY_SHARE_CODE_TASK = 'VERIFY_SHARE_CODE_TASK';
 
     public const ID_DOCUMENT = 'ID_DOCUMENT';
     public const SUPPLEMENTARY_DOCUMENT = 'SUPPLEMENTARY_DOCUMENT';

src/DocScan/Session/Create/Filters/RequiredShareCode.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yoti\DocScan\Session\Create\Filters;
+
+use JsonSerializable;
+use stdClass;
+use Yoti\Util\Json;
+
+class RequiredShareCode implements JsonSerializable
+{
+    /**
+     * @var string|null
+     */
+    private $issuer;
+
+    /**
+     * @var string|null
+     */
+    private $scheme;
+
+    /**
+     * @param string|null $issuer
+     * @param string|null $scheme
+     */
+    public function __construct(?string $issuer = null, ?string $scheme = null)
+    {
+        $this->issuer = $issuer;
+        $this->scheme = $scheme;
+    }
+
+    /**
+     * @return stdClass
+     */
+    public function jsonSerialize(): stdClass
+    {
+        return (object) Json::withoutNullValues([
+            'issuer' => $this->issuer,
+            'scheme' => $this->scheme,
+        ]);
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getIssuer(): ?string
+    {
+        return $this->issuer;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getScheme(): ?string
+    {
+        return $this->scheme;
+    }
+}

src/DocScan/Session/Create/Filters/RequiredShareCodeBuilder.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yoti\DocScan\Session\Create\Filters;
+
+class RequiredShareCodeBuilder
+{
+    /**
+     * @var string|null
+     */
+    private $issuer;
+
+    /**
+     * @var string|null
+     */
+    private $scheme;
+
+    /**
+     * @param string $issuer
+     *
+     * @return $this
+     */
+    public function withIssuer(string $issuer): self
+    {
+        $this->issuer = $issuer;
+        return $this;
+    }
+
+    /**
+     * @param string $scheme
+     *
+     * @return $this
+     */
+    public function withScheme(string $scheme): self
+    {
+        $this->scheme = $scheme;
+        return $this;
+    }
+
+    /**
+     * @return RequiredShareCode
+     */
+    public function build(): RequiredShareCode
+    {
+        return new RequiredShareCode($this->issuer, $this->scheme);
+    }
+}

src/DocScan/Session/Create/SessionSpecification.php

@@ -8,6 +8,7 @@
 use stdClass;
 use Yoti\DocScan\Session\Create\Check\RequestedCheck;
 use Yoti\DocScan\Session\Create\Filters\RequiredDocument;
+use Yoti\DocScan\Session\Create\Filters\RequiredShareCode;
 use Yoti\DocScan\Session\Create\Task\RequestedTask;
 use Yoti\Util\Json;
 
@@ -85,6 +86,11 @@ class SessionSpecification implements JsonSerializable
      */
     private $importToken;
 
+    /**
+     * @var RequiredShareCode[]
+     */
+    private $requiredShareCodes;
+
     /**
      * @param int|null $clientSessionTokenTtl
      * @param string|null $sessionDeadline
@@ -101,6 +107,7 @@ class SessionSpecification implements JsonSerializable
      * @param object|null $identityProfileRequirements
      * @param bool|null $createIdentityProfilePreview
      * @param ImportToken|null $importToken
+     * @param RequiredShareCode[] $requiredShareCodes
      */
     public function __construct(
         ?int $clientSessionTokenTtl,
@@ -117,7 +124,8 @@ public function __construct(
         ?object $subject = null,
         ?object $identityProfileRequirements = null,
         ?bool $createIdentityProfilePreview = null,
-        ?ImportToken $importToken = null
+        ?ImportToken $importToken = null,
+        array $requiredShareCodes = []
     ) {
         $this->clientSessionTokenTtl = $clientSessionTokenTtl;
         $this->sessionDeadline = $sessionDeadline;
@@ -134,6 +142,7 @@ public function __construct(
         $this->identityProfileRequirements = $identityProfileRequirements;
         $this->createIdentityProfilePreview = $createIdentityProfilePreview;
         $this->importToken = $importToken;
+        $this->requiredShareCodes = $requiredShareCodes;
     }
 
     /**
@@ -157,6 +166,7 @@ public function jsonSerialize(): stdClass
             'identity_profile_requirements' => $this->getIdentityProfileRequirements(),
             'create_identity_profile_preview' => $this->getCreateIdentityProfilePreview(),
             'import_token' => $this->getImportToken(),
+            'required_share_codes' => $this->getRequiredShareCodes(),
         ]);
     }
 
@@ -278,4 +288,12 @@ public function getImportToken(): ?ImportToken
     {
         return $this->importToken;
     }
+
+    /**
+     * @return RequiredShareCode[]
+     */
+    public function getRequiredShareCodes(): array
+    {
+        return $this->requiredShareCodes;
+    }
 }

src/DocScan/Session/Create/SessionSpecificationBuilder.php

@@ -7,6 +7,7 @@
 use DateTimeImmutable;
 use Yoti\DocScan\Session\Create\Check\RequestedCheck;
 use Yoti\DocScan\Session\Create\Filters\RequiredDocument;
+use Yoti\DocScan\Session\Create\Filters\RequiredShareCode;
 use Yoti\DocScan\Session\Create\Task\RequestedTask;
 
 class SessionSpecificationBuilder
@@ -88,6 +89,11 @@ class SessionSpecificationBuilder
      */
     private bool $createIdentityProfilePreview = false;
 
+    /**
+     * @var RequiredShareCode[]
+     */
+    private $requiredShareCodes = [];
+
     /**
      * @param int $clientSessionTokenTtl
      * @return $this
@@ -274,6 +280,32 @@ public function withImportToken($importToken): self
         return $this;
     }
 
+    /**
+     * Adds a RequiredShareCode to the list of share codes required from the client
+     *
+     * @param RequiredShareCode $requiredShareCode
+     *
+     * @return $this
+     */
+    public function withRequiredShareCode(RequiredShareCode $requiredShareCode): self
+    {
+        $this->requiredShareCodes[] = $requiredShareCode;
+        return $this;
+    }
+
+    /**
+     * Sets the list of share codes required from the client
+     *
+     * @param RequiredShareCode[] $requiredShareCodes
+     *
+     * @return $this
+     */
+    public function withRequiredShareCodes(array $requiredShareCodes): self
+    {
+        $this->requiredShareCodes = $requiredShareCodes;
+        return $this;
+    }
+
     /**
      * @return SessionSpecification
      */
@@ -295,6 +327,7 @@ public function build(): SessionSpecification
             $this->identityProfileRequirements,
             $this->createIdentityProfilePreview,
             $this->importToken,
+            $this->requiredShareCodes,
         );
     }
 }

src/DocScan/Session/Retrieve/ResourceContainer.php

@@ -26,6 +26,11 @@ class ResourceContainer
      */
     private $faceCapture = [];
 
+    /**
+     * @var ShareCodeResourceResponse[]
+     */
+    private $shareCodes = [];
+
     /**
      * ResourceContainer constructor.
      * @param array<string, mixed> $resources
@@ -47,6 +52,10 @@ public function __construct(array $resources)
         if (isset($resources['face_capture'])) {
             $this->faceCapture = $this->parseFaceCapture($resources['face_capture']);
         }
+
+        if (isset($resources['share_codes'])) {
+            $this->shareCodes = $this->parseShareCodes($resources['share_codes']);
+        }
     }
 
     /**
@@ -113,6 +122,19 @@ private function parseFaceCapture(array $faceCaptures): array
         return $parsedFaceCaptures;
     }
 
+    /**
+     * @param array<array<string, mixed>> $shareCodes
+     * @return ShareCodeResourceResponse[]
+     */
+    private function parseShareCodes(array $shareCodes): array
+    {
+        $parsedShareCodes = [];
+        foreach ($shareCodes as $shareCode) {
+            $parsedShareCodes[] = new ShareCodeResourceResponse($shareCode);
+        }
+        return $parsedShareCodes;
+    }
+
     /**
      * @return IdDocumentResourceResponse[]
      */
@@ -161,6 +183,14 @@ public function getFaceCapture(): array
         return $this->faceCapture;
     }
 
+    /**
+     * @return ShareCodeResourceResponse[]
+     */
+    public function getShareCodes(): array
+    {
+        return $this->shareCodes;
+    }
+
     /**
      * @param string $class
      * @return mixed[]

src/DocScan/Session/Retrieve/ResourceResponse.php

@@ -104,6 +104,8 @@ private function createTaskFromArray(array $task): TaskResponse
                 return new TextExtractionTaskResponse($task);
             case Constants::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION:
                 return new SupplementaryDocTextExtractionTaskResponse($task);
+            case Constants::VERIFY_SHARE_CODE_TASK:
+                return new VerifyShareCodeTaskResponse($task);
             default:
                 return new TaskResponse($task);
         }