Merge pull request #262 from getyoti/release-3.9.0

Release 3.9.0

Author: LuborRod

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "yoti/yoti-php-sdk",
   "description": "Yoti SDK for quickly integrating your PHP backend with Yoti",
-  "version": "3.8.0",
+  "version": "3.9.0",
   "keywords": [
     "yoti",
     "sdk"
@@ -12,7 +12,7 @@
     "php": "^7.1 || ^8.0",
     "ext-json": "*",
     "google/protobuf": "^3.10",
-    "phpseclib/phpseclib": "^2.0",
+    "phpseclib/phpseclib": "^3.0",
     "guzzlehttp/guzzle": "^6.4 || ^7.0",
     "psr/http-client": "^1.0",
     "psr/http-message": "^1.0",

src/Constants.php

@@ -25,7 +25,7 @@ class Constants
     public const SDK_IDENTIFIER = 'PHP';
 
     /** Default SDK version */
-    public const SDK_VERSION = '3.8.0';
+    public const SDK_VERSION = '3.9.0';
 
     /** Base url for connect page (user will be redirected to this page eg. baseurl/app-id) */
     public const CONNECT_BASE_URL = 'https://www.yoti.com/connect';

src/DocScan/DocScanClient.php

@@ -12,6 +12,8 @@
 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\ContactProfileResponse;
+use Yoti\DocScan\Session\Retrieve\Instructions\InstructionsResponse;
 use Yoti\DocScan\Support\SupportedDocumentsResponse;
 use Yoti\Media\Media;
 use Yoti\Util\Config;
@@ -193,4 +195,53 @@ public function putIbvInstructions(string $sessionId, Instructions $instructions
     {
         $this->docScanService->putIbvInstructions($sessionId, $instructions);
     }
+
+    /**
+     * Fetches any currently set instructions for an IBV session.
+     *
+     * @param string $sessionId
+     * @return InstructionsResponse
+     * @throws Exception\DocScanException
+     */
+    public function getIbvInstructions(string $sessionId): InstructionsResponse
+    {
+        return $this->docScanService->getIbvInstructions($sessionId);
+    }
+
+    /**
+     * Fetches the instructions PDF associated with an In-Branch Verification session.
+     *
+     * @param string $sessionId
+     * @return Media
+     * @throws Exception\DocScanException
+     */
+    public function getIbvInstructionsPdf(string $sessionId): Media
+    {
+        return $this->docScanService->getIbvInstructionsPdf($sessionId);
+    }
+
+    /**
+     * Fetches the associated instructions contact profile for the given In-Branch Verification session
+     *
+     * @param string $sessionId
+     * @return ContactProfileResponse
+     * @throws Exception\DocScanException
+     */
+    public function fetchInstructionsContactProfile(string $sessionId): ContactProfileResponse
+    {
+        return $this->docScanService->fetchInstructionsContactProfile($sessionId);
+    }
+
+    /**
+     * Triggers an email notification for the IBV instructions at-home flow.
+     * This will be one of:
+     *  - an email sent directly to the end user, using the email provided in the ContactProfile
+     *  - if requested, a backend notification using the configured notification endpoint
+     *
+     * @throws Exception\DocScanException
+     */
+    public function triggerIbvEmailNotification(string $sessionId): void
+    {
+        $this->docScanService->triggerIbvEmailNotification($sessionId);
+    }
 }

src/DocScan/Service.php

@@ -15,6 +15,8 @@
 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\ContactProfileResponse;
+use Yoti\DocScan\Session\Retrieve\Instructions\InstructionsResponse;
 use Yoti\DocScan\Support\SupportedDocumentsResponse;
 use Yoti\Http\Payload;
 use Yoti\Http\Request;
@@ -309,6 +311,90 @@ 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 string $sessionId
+     * @return Media
+     * @throws DocScanException
+     */
+    public function getIbvInstructionsPdf(string $sessionId): Media
+    {
+        $response = (new RequestBuilder($this->config))
+            ->withBaseUrl($this->apiUrl)
+            ->withPemFile($this->pemFile)
+            ->withEndpoint(sprintf('/sessions/%s/instructions/pdf', $sessionId))
+            ->withGet()
+            ->build()
+            ->execute();
+
+        self::assertResponseIsSuccess($response);
+
+        $content = (string)$response->getBody();
+        $mimeType = $response->getHeader("Content-Type")[0] ?? '';
+
+        return new Media($mimeType, $content);
+    }
+
+    /**
+     * @param string $sessionId
+     * @return ContactProfileResponse
+     * @throws DocScanException
+     */
+    public function fetchInstructionsContactProfile(string $sessionId): ContactProfileResponse
+    {
+        $response = (new RequestBuilder($this->config))
+            ->withBaseUrl($this->apiUrl)
+            ->withPemFile($this->pemFile)
+            ->withEndpoint(sprintf('/sessions/%s/instructions/contact-profile', $sessionId))
+            ->withGet()
+            ->build()
+            ->execute();
+
+        self::assertResponseIsSuccess($response);
+
+        $result = Json::decode((string)$response->getBody());
+
+        return new ContactProfileResponse($result);
+    }
+
+    /**
+     * @param string $sessionId
+     * @throws DocScanException
+     */
+    public function triggerIbvEmailNotification(string $sessionId): void
+    {
+        $response = (new RequestBuilder($this->config))
+            ->withBaseUrl($this->apiUrl)
+            ->withPemFile($this->pemFile)
+            ->withEndpoint(sprintf('/sessions/%s/instructions/email', $sessionId))
+            ->withPost()
+            ->build()
+            ->execute();
+
+        self::assertResponseIsSuccess($response);
+    }
+
     /**
      * @param ResponseInterface $response
      *

src/DocScan/Session/Create/Filters/Document/DocumentRestrictionsFilter.php

@@ -20,11 +20,17 @@ class DocumentRestrictionsFilter extends DocumentFilter implements \JsonSerializ
      */
     private $documents;
 
+    /**
+     * @var bool|null
+     */
+    private $allowNonLatinDocuments;
+
     /**
      * @param string $inclusion
      * @param DocumentRestriction[] $documents
+     * @param bool|null $allowNonLatinDocuments
      */
-    public function __construct(string $inclusion, array $documents)
+    public function __construct(string $inclusion, array $documents, ?bool $allowNonLatinDocuments)
     {
         parent::__construct(Constants::DOCUMENT_RESTRICTIONS);
 
@@ -34,6 +40,7 @@ public function __construct(string $inclusion, array $documents)
         Validation::notEmptyArray($documents, 'documents');
         Validation::isArrayOfType($documents, [DocumentRestriction::class], 'documents');
         $this->documents = $documents;
+        $this->allowNonLatinDocuments = $allowNonLatinDocuments;
     }
 
     /**
@@ -44,6 +51,19 @@ public function jsonSerialize(): \stdClass
         $jsonData = parent::jsonSerialize();
         $jsonData->inclusion = $this->inclusion;
         $jsonData->documents = $this->documents;
+
+        if (isset($this->allowNonLatinDocuments)) {
+            $jsonData->allow_non_latin_documents = $this->allowNonLatinDocuments;
+        }
+
         return $jsonData;
     }
+
+    /**
+     * @return bool|null
+     */
+    public function isAllowNonLatinDocuments(): ?bool
+    {
+        return $this->allowNonLatinDocuments;
+    }
 }

src/DocScan/Session/Create/Filters/Document/DocumentRestrictionsFilterBuilder.php

@@ -20,6 +20,11 @@ class DocumentRestrictionsFilterBuilder
      */
     private $documents = [];
 
+    /**
+     * @var bool|null
+     */
+    private $allowNonLatinDocuments;
+
     /**
      * @return $this
      */
@@ -49,12 +54,25 @@ public function withDocumentRestriction(DocumentRestriction $documentRestriction
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    public function withAllowNonLatinDocuments(): self
+    {
+        $this->allowNonLatinDocuments = true;
+        return $this;
+    }
+
     /**
      * @return DocumentRestrictionsFilter
      */
     public function build(): DocumentFilter
     {
         Validation::notEmptyString($this->inclusion, 'inclusion');
-        return new DocumentRestrictionsFilter($this->inclusion, $this->documents);
+        return new DocumentRestrictionsFilter(
+            $this->inclusion,
+            $this->documents,
+            $this->allowNonLatinDocuments
+        );
     }
 }

src/DocScan/Session/Create/IbvOptions.php

@@ -2,7 +2,10 @@
 
 namespace Yoti\DocScan\Session\Create;
 
-class IbvOptions
+use JsonSerializable;
+use Yoti\Util\Json;
+
+class IbvOptions implements JsonSerializable
 {
     /**
      * @var string
@@ -39,4 +42,16 @@ public function getGuidanceUrl(): ?string
     {
         return $this->guidanceUrl;
     }
+
+
+    /**
+     * @return \stdClass
+     */
+    public function jsonSerialize(): \stdClass
+    {
+        return (object)Json::withoutNullValues([
+            'support' => $this->getSupport(),
+            'guidance_url' => $this->getGuidanceUrl(),
+        ]);
+    }
 }

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;
+    }
+}