Added support for Interactive reply buttons media header

README.md

@@ -268,12 +268,13 @@ $whatsapp_cloud_api->sendCatalog(
 ```
 
 ### Send a button reply message
-
+Button reply with Text Header
 ```php
 <?php
 
 use Netflie\WhatsAppCloudApi\WhatsAppCloudApi;
 use Netflie\WhatsAppCloudApi\Message\ButtonReply\Button;
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\TextHeader;
 use Netflie\WhatsAppCloudApi\Message\ButtonReply\ButtonAction;
 
 $whatsapp_cloud_api = new WhatsAppCloudApi([
@@ -288,15 +289,61 @@ $rows = [
 ];
 $action = new ButtonAction($rows);
 
+$header = new TextHeader('RATE US');
+
 $whatsapp_cloud_api->sendButton(
     '<destination-phone-number>',
     'Would you like to rate us on Trustpilot?',
     $action,
-    'RATE US', // Optional: Specify a header (type "text")
+    $header, // Optional, can be text, image, video, or document
     'Please choose an option' // Optional: Specify a footer 
 );
 ```
 
+Button Reply with Image Header
+```php
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\ImageHeader;
+use Netflie\WhatsAppCloudApi\Message\Media\LinkID;
+
+$link_id = new LinkID('http(s)://image-url');
+$header = new ImageHeader($link_id);
+
+//or
+
+$media_id = new MediaObjectID('<image-object-id>');
+$header = new ImageHeader($media_id);
+```
+
+Button Reply with Video Header
+```php
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\VideoHeader;
+use Netflie\WhatsAppCloudApi\Message\Media\LinkID;
+
+$link_id = new LinkID('http(s)://video-url');
+$header = new VideoHeader($link_id);
+
+//or
+
+$media_id = new MediaObjectID('<video-object-id>');
+$header = new VideoHeader($media_id);
+```
+
+Button Reply with Document Header
+```php
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\DocumentHeader;
+use Netflie\WhatsAppCloudApi\Message\Media\LinkID;
+
+$filename = 'whatsapp-cloud-api-from-url.pdf';
+$link_id = new LinkID('http(s)://document-url');
+$header = new DocumentHeader($link_id);
+
+//or
+
+$filename = 'whatsapp-cloud-api-from-id.pdf';
+$media_id = new MediaObjectID('<document-object-id>');
+$header = new DocumentoHeader($media_id,);
+```
+
 ### Send Multi Product Message
 ```php
 <?php

src/Message/ButtonReply/DocumentHeader.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message\ButtonReply;
+
+use Netflie\WhatsAppCloudApi\Message\Media\MediaID;
+
+final class DocumentHeader extends Header
+{
+    protected string $type = 'document';
+    private MediaID $id;
+    private string $filename;
+
+    public function __construct(MediaID $id, string $filename)
+    {
+        $this->id = $id;
+        $this->filename = $filename;
+    }
+
+    public function getBody(): array
+    {
+        return [
+            'type' => $this->type,
+            'document' => [
+                $this->id->type() => $this->id->value(),
+                'filename' => $this->filename,
+            ],
+        ];
+    }
+}

src/Message/ButtonReply/Header.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message\ButtonReply;
+
+abstract class Header
+{
+    protected string $type;
+
+    abstract public function getBody(): array;
+}

src/Message/ButtonReply/ImageHeader.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message\ButtonReply;
+
+use Netflie\WhatsAppCloudApi\Message\Media\MediaID;
+
+final class ImageHeader extends Header
+{
+    protected string $type = 'image';
+    private MediaID $id;
+
+    public function __construct(MediaID $id)
+    {
+        $this->id = $id;
+    }
+
+    public function getBody(): array
+    {
+        return [
+            'type' => $this->type,
+            'image' => [
+                $this->id->type() => $this->id->value(),
+            ],
+        ];
+    }
+}

src/Message/ButtonReply/TextHeader.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message\ButtonReply;
+
+final class TextHeader extends Header
+{
+    protected string $type = 'text';
+    private string $text;
+
+    public function __construct(string $text)
+    {
+        $this->text = $text;
+    }
+
+    public function getBody(): array
+    {
+        return [
+            'type' => $this->type,
+            'text' => $this->text,
+        ];
+    }
+}

src/Message/ButtonReply/VideoHeader.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message\ButtonReply;
+
+use Netflie\WhatsAppCloudApi\Message\Media\MediaID;
+
+final class VideoHeader extends Header
+{
+    protected string $type = 'video';
+    private MediaID $id;
+
+    public function __construct(MediaID $id)
+    {
+        $this->id = $id;
+    }
+
+    public function getBody(): array
+    {
+        return [
+            'type' => $this->type,
+            'video' => [
+                $this->id->type() => $this->id->value(),
+            ],
+        ];
+    }
+}

src/Message/ButtonReplyMessage.php

@@ -3,20 +3,21 @@
 namespace Netflie\WhatsAppCloudApi\Message;
 
 use Netflie\WhatsAppCloudApi\Message\ButtonReply\ButtonAction;
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\Header;
 
-class ButtonReplyMessage extends Message
+final class ButtonReplyMessage extends Message
 {
     protected string $type = 'button';
 
-    private ?string $header;
+    private ?Header $header;
 
     private string $body;
 
     private ?string $footer;
 
     private ButtonAction $action;
 
-    public function __construct(string $to, string $body, ButtonAction $action, ?string $header = null, ?string $footer = null, ?string $reply_to = null)
+    public function __construct(string $to, string $body, ButtonAction $action, ?Header $header = null, ?string $footer = null, ?string $reply_to = null)
     {
         $this->body = $body;
         $this->action = $action;
@@ -26,9 +27,9 @@ public function __construct(string $to, string $body, ButtonAction $action, ?str
         parent::__construct($to, $reply_to);
     }
 
-    public function header(): ?string
+    public function header(): ?array
     {
-        return $this->header;
+        return $this->header ? $this->header->getBody() : null;
     }
 
     public function body(): string

src/Request/MessageRequest/RequestButtonReplyMessage.php

@@ -4,7 +4,7 @@
 
 use Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-class RequestButtonReplyMessage extends MessageRequest
+final class RequestButtonReplyMessage extends MessageRequest
 {
     public function body(): array
     {
@@ -21,10 +21,7 @@ public function body(): array
         ];
 
         if ($this->message->header()) {
-            $body['interactive']['header'] = [
-                'type' => 'text',
-                'text' => $this->message->header(),
-            ];
+            $body['interactive']['header'] = $this->message->header();
         }
 
         if ($this->message->footer()) {

src/WhatsAppCloudApi.php

@@ -3,9 +3,12 @@
 namespace Netflie\WhatsAppCloudApi;
 
 use Netflie\WhatsAppCloudApi\Message\ButtonReply\ButtonAction;
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\Header as ButtonHeader;
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\TextHeader;
 use Netflie\WhatsAppCloudApi\Message\Contact\ContactName;
 use Netflie\WhatsAppCloudApi\Message\Contact\Phone;
 use Netflie\WhatsAppCloudApi\Message\CtaUrl\Header;
+use Netflie\WhatsAppCloudApi\Message\Error\InvalidMessage;
 use Netflie\WhatsAppCloudApi\Message\Media\MediaID;
 use Netflie\WhatsAppCloudApi\Message\MultiProduct\Action as MultiProductAction;
 use Netflie\WhatsAppCloudApi\Message\OptionsList\Action;
@@ -235,7 +238,7 @@ public function sendSticker(string $to, MediaID $sticker_id): Response
      * @param  float    $longitude  Longitude position.
      * @param  float    $latitude   Latitude position.
      * @param  string   $name       Name of location sent.
-     * @param  address  $address    Address of location sent.
+     * @param  string   $address    Address of location sent.
      *
      * @return Response
      *
@@ -354,8 +357,15 @@ public function sendCtaUrl(string $to, string $displayText, string $url, ?Header
         return $this->client->sendMessage($request);
     }
 
-    public function sendButton(string $to, string $body, ButtonAction $action, ?string $header = null, ?string $footer = null): Response
+    public function sendButton(string $to, string $body, ButtonAction $action, $header = null, ?string $footer = null): Response
     {
+        if (is_string($header)) {
+            $header = new TextHeader($header);
+        }
+
+        if (!$header instanceof ButtonHeader && $header !== null) {
+            throw new InvalidMessage('Header must be instance of Netflie\WhatsAppCloudApi\Message\ButtonReply\Header if not left null');
+        }
         $message = new Message\ButtonReplyMessage(
             $to,
             $body,