Merge pull request #197 from pravnyadv/main

adding flow message support
netflie · Aug 6, 2024 · 8e98f7a · 8e98f7a
2 parents 955728a + cdfe9b0
commit 8e98f7a
Show file tree

Hide file tree

Showing 7 changed files with 113 additions and 5 deletions.
diff --git a/src/Message/CtaUrl/TitleHeader.php b/src/Message/CtaUrl/TitleHeader.php
@@ -2,8 +2,6 @@
 
 namespace Netflie\WhatsAppCloudApi\Message\CtaUrl;
 
-use Netflie\WhatsAppCloudApi\Message\CtaUrl\Header;
-
 final class TitleHeader extends Header
 {
     protected string $title;

diff --git a/src/Request/BusinessProfileRequest/UpdateBusinessProfileRequest.php b/src/Request/BusinessProfileRequest/UpdateBusinessProfileRequest.php
@@ -33,7 +33,7 @@ public function body(): array
     {
         return array_merge(
             [
-                'messaging_product' => 'whatsapp'
+                'messaging_product' => 'whatsapp',
             ],
             $this->information
         );

diff --git a/src/WebHook/Notification/Flow.php b/src/WebHook/Notification/Flow.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\WebHook\Notification;
+
+final class Flow extends MessageNotification
+{
+    private string $name;
+
+    private string $body;
+
+    private string $response;
+
+    public function __construct(
+        string $id,
+        Support\Business $business,
+        string $name,
+        string $body,
+        string $response,
+        string $received_at_timestamp
+    ) {
+        parent::__construct($id, $business, $received_at_timestamp);
+
+        $this->name = $name;
+        $this->body = $body;
+        $this->response = $response;
+    }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+
+    public function body(): string
+    {
+        return $this->body;
+    }
+
+    public function response(): string
+    {
+        return $this->response;
+    }
+}
diff --git a/src/WebHook/Notification/MessageNotificationFactory.php b/src/WebHook/Notification/MessageNotificationFactory.php
@@ -77,6 +77,19 @@ private function buildMessageNotification(array $metadata, array $message): Mess
                     $message['timestamp']
                 );
             case 'interactive':
+                if (isset($message['interactive']['nfm_reply'])) {
+                    $nfmReply = $message['interactive']['nfm_reply'];
+
+                    return new Flow(
+                        $message['id'],
+                        new Support\Business($metadata['phone_number_id'], $metadata['display_phone_number']),
+                        $nfmReply['name'],
+                        $nfmReply['body'],
+                        $nfmReply['response_json'] ?? '',
+                        $message['timestamp'],
+                    );
+                }
+
                 return new Interactive(
                     $message['id'],
                     new Support\Business($metadata['phone_number_id'], $metadata['display_phone_number']),

diff --git a/tests/Integration/ClientTest.php b/tests/Integration/ClientTest.php
@@ -96,7 +96,7 @@ public function test_update_business_profile()
         $request = new Request\BusinessProfileRequest\UpdateBusinessProfileRequest(
             [
                 'about' => 'About text',
-                'email' => 'my-email@email.com'
+                'email' => 'my-email@email.com',
             ],
             WhatsAppCloudApiTestConfiguration::$access_token,
             WhatsAppCloudApiTestConfiguration::$from_phone_number_id

diff --git a/tests/Unit/WebHook/NotificationFactoryTest.php b/tests/Unit/WebHook/NotificationFactoryTest.php
@@ -768,6 +768,61 @@ public function test_build_from_payload_can_build_a_button_reply_notification()
         $this->assertEquals('', $notification->description());
     }
 
+    public function test_build_from_payload_can_build_a_flow_notification()
+    {
+        $payload = json_decode('{
+          "object": "whatsapp_business_account",
+          "entry": [
+            {
+              "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
+              "changes": [
+                {
+                  "value": {
+                      "messaging_product": "whatsapp",
+                      "metadata": {
+                           "display_phone_number": "PHONE_NUMBER",
+                           "phone_number_id": "PHONE_NUMBER_ID"
+                      },
+                      "contacts": [
+                        {
+                          "profile": {
+                            "name": "NAME"
+                          },
+                          "wa_id": "PHONE_NUMBER_ID"
+                        }
+                      ],
+                      "messages": [
+                        {
+                          "from": "PHONE_NUMBER_ID",
+                          "id": "wamid.ID",
+                          "timestamp": 1669233778,
+                          "interactive": {
+                            "type": "nfm_reply",
+                            "nfm_reply": {
+                              "response_json": "{\"screen_0_name_0\":\"Email\",\"screen_0_orderNumber_1\":\"ID\",\"flow_token\":\"unused\"}",
+                              "body": "Sent",
+                              "name": "flow"
+                            }
+                          },
+                          "type": "interactive"
+                        }
+                      ]
+                  },
+                  "field": "messages"
+                }
+              ]
+            }
+          ]
+        }', true);
+
+        $notification = $this->notification_factory->buildFromPayload($payload);
+
+        $this->assertInstanceOf(Notification\Flow::class, $notification);
+        $this->assertEquals('flow', $notification->name());
+        $this->assertEquals('Sent', $notification->body());
+        $this->assertEquals('{"screen_0_name_0":"Email","screen_0_orderNumber_1":"ID","flow_token":"unused"}', $notification->response());
+    }
+
     public function test_build_from_payload_can_build_an_order_notification()
     {
         $payload = json_decode('{

diff --git a/tests/Unit/WhatsAppCloudApiTest.php b/tests/Unit/WhatsAppCloudApiTest.php
@@ -953,7 +953,7 @@ public function test_send_cta_url()
             'parameters' => [
                 'display_text' => $this->faker->text(24),
                 'url' => $this->faker->url,
-            ]
+            ],
         ];
 
         $body = [