Merge pull request #70 from onfido/release-upgrade

Refresh onfido-php after onfido-openapi-spec update (964fb43)

.release.json

@@ -1,9 +1,9 @@
 {
   "source": {
     "repo_url": "https://github.com/onfido/onfido-openapi-spec",
-    "short_sha": "8c793a1",
-    "long_sha": "8c793a1c8307dcd92fa657edb2a1e9b184c15278",
-    "version": "v4.3.0"
+    "short_sha": "964fb43",
+    "long_sha": "964fb43a1bf211197ef7a45c230771b8ba561b3c",
+    "version": "v4.4.0"
   },
-  "release": "v8.3.0"
+  "release": "v8.4.0"
 }

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "onfido/onfido-php",
-    "version": "8.3.0",
+    "version": "8.4.0",
     "description": "The Onfido API (v3.6)",
     "keywords": [
         "openapitools",

lib/Configuration.php

@@ -87,7 +87,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = 'onfido-php/8.3.0';
+    protected $userAgent = 'onfido-php/8.4.0';
 
     /**
      * Debug switch (default set to false)
@@ -404,7 +404,7 @@ public static function toDebugReport()
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
         $report .= '    The version of the OpenAPI document: v3.6' . PHP_EOL;
-        $report .= '    SDK Package Version: 8.3.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 8.4.0' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;

lib/Model/Task.php

@@ -511,7 +511,7 @@ public function getOutput()
     /**
      * Sets output
      *
-     * @param object|null $output Output object with the fields produced by the Task execution.
+     * @param object|null $output Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
      *
      * @return self
      */

lib/Model/WebhookEventPayloadResource.php

@@ -714,7 +714,7 @@ public function getOutput()
     /**
      * Sets output
      *
-     * @param object|null $output Output object with the fields produced by the Task execution.
+     * @param object|null $output Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
      *
      * @return self
      */

lib/Model/WebhookEventResourceType.php

@@ -54,6 +54,10 @@ class WebhookEventResourceType
 
     public const WATCHLIST_MONITOR = 'watchlist_monitor';
 
+    public const WORKFLOW_TIMELINE_FILE = 'workflow_timeline_file';
+
+    public const WORKFLOW_RUN_EVIDENCE_FOLDER = 'workflow_run_evidence_folder';
+
     public const UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api';
 
     /**
@@ -69,6 +73,8 @@ public static function getAllowableEnumValues()
             self::WORKFLOW_RUN,
             self::WORKFLOW_TASK,
             self::WATCHLIST_MONITOR,
+            self::WORKFLOW_TIMELINE_FILE,
+            self::WORKFLOW_RUN_EVIDENCE_FOLDER,
             self::UNKNOWN_DEFAULT_OPEN_API
         ];
     }

lib/Model/WebhookEventType.php

@@ -76,6 +76,8 @@ class WebhookEventType
 
     public const WORKFLOW_SIGNED_EVIDENCE_FILE_CREATED = 'workflow_signed_evidence_file.created';
 
+    public const WORKFLOW_RUN_EVIDENCE_FOLDER_CREATED = 'workflow_run_evidence_folder.created';
+
     public const UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api';
 
     /**
@@ -102,6 +104,7 @@ public static function getAllowableEnumValues()
             self::REPORT_COMPLETED,
             self::WORKFLOW_TIMELINE_FILE_CREATED,
             self::WORKFLOW_SIGNED_EVIDENCE_FILE_CREATED,
+            self::WORKFLOW_RUN_EVIDENCE_FOLDER_CREATED,
             self::UNKNOWN_DEFAULT_OPEN_API
         ];
     }

test/StudioWebhookEventVerifierTest.php

@@ -54,4 +54,26 @@ public function testInvalidSignature()
         $this->expectException(Onfido\OnfidoInvalidSignatureError::class);
         $event = self::$webhookEventVerifier->readPayload(self::$rawEvent, $signature);
     }
+
+    public function testWebhookVerificationWithObjectInOuput(): void
+    {
+        $signature = "e3e5565647f5ccf07b2fd8ac22eab94a0a0619413d981fb768295c820523f7d7";
+
+        $rawEventFromFile = file_get_contents('test/media/studio_webhook_event_with_object_in_output.json');
+        $event = self::$webhookEventVerifier->readPayload($rawEventFromFile, $signature);
+
+        $this->assertNotNull($event->getPayload()->getResource()->getOutput()['properties']);
+    }
+
+
+    public function testWebhookVerificationWithListInOuput(): void
+    {
+        $signature = "f3a5170acfcecf8c1bf6d9cb9995c0d9dec941af83056a721530f8de7af2c293";
+
+        $rawEventFromFile = file_get_contents('test/media/studio_webhook_event_with_list_in_output.json');
+        $event = self::$webhookEventVerifier->readPayload($rawEventFromFile, $signature);
+
+        $this->assertNotNull($event->getPayload()->getResource()->getOutput()[0]);
+    }
+
 }

test/media/studio_webhook_event_with_list_in_output.json

@@ -0,0 +1,31 @@
+{
+  "payload": {
+    "resource_type": "workflow_task",
+    "action": "workflow_task.completed",
+    "object": {
+      "id": "document_photo_5c229",
+      "task_spec_id": "document_photo_5c229",
+      "task_def_id": "upload_document_photo",
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "status": "completed",
+      "completed_at_iso8601": "2024-12-18T18:13:10Z",
+      "href": "https://api.eu.onfido.com/v3.6/workflow_runs/b48fdff9-66a1-405d-9912-54780799bd68/tasks/document_photo_5c229"
+    },
+    "resource": {
+      "updated_at": "2024-12-18T18:13:10Z",
+      "output": [
+        {
+          "type": "document_photo",
+          "id": "7af75a3a-ba34-4aa5-9e3e-096c9f56256b",
+          "checksum_sha256": "hiwV2PLmeQZzeySPGGwVL48sxVXcyfpXy9LDl1u3lWU="
+        }
+      ],
+      "created_at": "2024-12-18T18:12:44Z",
+      "task_def_id": "upload_document_photo",
+      "input": {},
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "task_def_version": null,
+      "id": "document_photo_5c229"
+    }
+  }
+}