Add new messages fields (#486)

SecondeJK · web-flow · commit 83d4927adce2 · 2024-07-02T14:41:01.000+01:00
* Add new messages fields

* Add a basic test for the validation client due to codecov
diff --git a/src/Messages/Channel/MMS/MMSAudio.php b/src/Messages/Channel/MMS/MMSAudio.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\MessageObjects\AudioObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\TtlTrait;
 
 class MMSAudio extends BaseMessage
 {
+    use TtlTrait;
+
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_AUDIO;
 
@@ -24,6 +27,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['audio'] = $this->audioObject->toArray();
 
+        if (!is_null($this->ttl)) {
+            $returnArray['ttl'] = $this->ttl;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/MMS/MMSImage.php b/src/Messages/Channel/MMS/MMSImage.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\MessageObjects\ImageObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\TtlTrait;
 
 class MMSImage extends BaseMessage
 {
+    use TtlTrait;
+
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_IMAGE;
 
@@ -24,6 +27,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['image'] = $this->image->toArray();
 
+        if (!is_null($this->ttl)) {
+            $returnArray['ttl'] = $this->ttl;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/MMS/MMSVideo.php b/src/Messages/Channel/MMS/MMSVideo.php
@@ -5,9 +5,12 @@
 use Vonage\Messages\MessageObjects\AudioObject;
 use Vonage\Messages\MessageObjects\VideoObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\TtlTrait;
 
 class MMSVideo extends BaseMessage
 {
+    use TtlTrait;
+
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VIDEO;
 
@@ -25,6 +28,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['video'] = $this->videoObject->toArray();
 
+        if (!is_null($this->ttl)) {
+            $returnArray['ttl'] = $this->ttl;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/MMS/MMSvCard.php b/src/Messages/Channel/MMS/MMSvCard.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\MessageObjects\VCardObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\TtlTrait;
 
 class MMSvCard extends BaseMessage
 {
+    use TtlTrait;
+
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VCARD;
 
@@ -24,6 +27,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['vcard'] = $this->vCard->toArray();
 
+        if (!is_null($this->ttl)) {
+            $returnArray['ttl'] = $this->ttl;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppAudio.php b/src/Messages/Channel/WhatsApp/WhatsAppAudio.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\MessageObjects\AudioObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\ContextTrait;
 
 class WhatsAppAudio extends BaseMessage
 {
+    use ContextTrait;
+
     protected string $channel = 'whatsapp';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_AUDIO;
 
@@ -24,6 +27,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['audio'] = $this->audioObject->toArray();
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return $returnArray;
     }
-}
+}
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppCustom.php b/src/Messages/Channel/WhatsApp/WhatsAppCustom.php
@@ -3,9 +3,12 @@
 namespace Vonage\Messages\Channel\WhatsApp;
 
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\ContextTrait;
 
 class WhatsAppCustom extends BaseMessage
 {
+    use ContextTrait;
+
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_CUSTOM;
     protected string $channel = 'whatsapp';
 
@@ -33,6 +36,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['custom'] = $this->getCustom();
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppFile.php b/src/Messages/Channel/WhatsApp/WhatsAppFile.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\MessageObjects\FileObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\ContextTrait;
 
 class WhatsAppFile extends BaseMessage
 {
+    use ContextTrait;
+
     protected string $channel = 'whatsapp';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_FILE;
 
@@ -24,6 +27,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['file'] = $this->fileObject->toArray();
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppImage.php b/src/Messages/Channel/WhatsApp/WhatsAppImage.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\MessageObjects\ImageObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\ContextTrait;
 
 class WhatsAppImage extends BaseMessage
 {
+    use ContextTrait;
+
     protected string $channel = 'whatsapp';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_IMAGE;
 
@@ -24,6 +27,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['image'] = $this->image->toArray();
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppSticker.php b/src/Messages/Channel/WhatsApp/WhatsAppSticker.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\Channel\BaseMessage;
 use Vonage\Messages\Channel\WhatsApp\MessageObjects\StickerObject;
+use Vonage\Messages\MessageTraits\ContextTrait;
 
 class WhatsAppSticker extends BaseMessage
 {
+    use ContextTrait;
+
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_STICKER;
     protected string $channel = 'whatsapp';
 
@@ -36,6 +39,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['sticker'] = $this->getSticker()->toArray();
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppTemplate.php b/src/Messages/Channel/WhatsApp/WhatsAppTemplate.php
@@ -5,9 +5,12 @@
 use Vonage\Messages\MessageObjects\FileObject;
 use Vonage\Messages\MessageObjects\TemplateObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\ContextTrait;
 
 class WhatsAppTemplate extends BaseMessage
 {
+    use ContextTrait;
+
     protected string $channel = 'whatsapp';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_TEMPLATE;
 
@@ -31,6 +34,10 @@ public function toArray(): array
             ]
         ];
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return array_merge($this->getBaseMessageUniversalOutputArray(), $returnArray);
     }
 
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppText.php b/src/Messages/Channel/WhatsApp/WhatsAppText.php
@@ -2,11 +2,13 @@
 
 namespace Vonage\Messages\Channel\WhatsApp;
 
+use Vonage\Messages\MessageTraits\ContextTrait;
 use Vonage\Messages\MessageTraits\TextTrait;
 use Vonage\Messages\Channel\BaseMessage;
 
 class WhatsAppText extends BaseMessage
 {
+    use ContextTrait;
     use TextTrait;
 
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_TEXT;
@@ -27,6 +29,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['text'] = $this->getText();
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/Channel/WhatsApp/WhatsAppVideo.php b/src/Messages/Channel/WhatsApp/WhatsAppVideo.php
@@ -4,9 +4,12 @@
 
 use Vonage\Messages\MessageObjects\VideoObject;
 use Vonage\Messages\Channel\BaseMessage;
+use Vonage\Messages\MessageTraits\ContextTrait;
 
 class WhatsAppVideo extends BaseMessage
 {
+    use ContextTrait;
+
     protected string $channel = 'whatsapp';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VIDEO;
 
@@ -24,6 +27,10 @@ public function toArray(): array
         $returnArray = $this->getBaseMessageUniversalOutputArray();
         $returnArray['video'] = $this->videoObject->toArray();
 
+        if (!is_null($this->context)) {
+            $returnArray['context'] = $this->context;
+        }
+
         return $returnArray;
     }
 }
diff --git a/src/Messages/MessageTraits/ContextTrait.php b/src/Messages/MessageTraits/ContextTrait.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Vonage\Messages\MessageTraits;
+
+trait ContextTrait
+{
+    private ?array $context;
+
+    public function getContext(): ?array
+    {
+        return $this->context;
+    }
+
+    public function setContext(?array $context): static
+    {
+        $this->context = $context;
+
+        return $this;
+    }
+}
diff --git a/src/Messages/MessageTraits/TtlTrait.php b/src/Messages/MessageTraits/TtlTrait.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Vonage\Messages\MessageTraits;
+
+trait TtlTrait
+{
+    private ?int $ttl;
+
+    public function getTtl(): ?int
+    {
+        return $this->ttl;
+    }
+
+    public function setTTl(?int $ttl): static
+    {
+        $this->ttl = $ttl;
+
+        return $this;
+    }
+}
diff --git a/test/Client/Exception/Validation.php b/test/Client/Exception/Validation.php
@@ -0,0 +1,35 @@
+<?php
+declare(strict_types=1);
+
+namespace VonageTest\Client\Exception;
+
+use PHPUnit\Framework\TestCase;
+use Vonage\Client\Exception\Exception;
+
+class Validation extends TestCase
+{
+    public function testValidationException()
+    {
+        $message = 'Validation failed';
+        $code = 422;
+        $previous = new Exception('Previous exception');
+        $errors = [
+            'field1' => 'Error message 1',
+            'field2' => 'Error message 2'
+        ];
+
+        $exception = new Validation($message, $code, $previous, $errors);
+
+        // Assert the exception message
+        $this->assertEquals($message, $exception->getMessage());
+
+        // Assert the exception code
+        $this->assertEquals($code, $exception->getCode());
+
+        // Assert the previous exception
+        $this->assertSame($previous, $exception->getPrevious());
+
+        // Assert the validation errors
+        $this->assertEquals($errors, $exception->getValidationErrors());
+    }
+}
diff --git a/test/Messages/ClientTest.php b/test/Messages/ClientTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,12 @@`
`4`	`4`
`5`	`5`	`use Vonage\Messages\MessageObjects\AudioObject;`
`6`	`6`	`use Vonage\Messages\Channel\BaseMessage;`
	`7`	`+use Vonage\Messages\MessageTraits\TtlTrait;`
`7`	`8`
`8`	`9`	`class MMSAudio extends BaseMessage`
`9`	`10`	`{`
	`11`	`+ use TtlTrait;`
	`12`	`+`
`10`	`13`	`protected string $channel = 'mms';`
`11`	`14`	`protected string $subType = BaseMessage::MESSAGES_SUBTYPE_AUDIO;`
`12`	`15`
`@@ -24,6 +27,10 @@ public function toArray(): array`
`24`	`27`	`$returnArray = $this->getBaseMessageUniversalOutputArray();`
`25`	`28`	`$returnArray['audio'] = $this->audioObject->toArray();`
`26`	`29`
	`30`	`+ if (!is_null($this->ttl)) {`
	`31`	`+ $returnArray['ttl'] = $this->ttl;`
	`32`	`+ }`
	`33`	`+`
`27`	`34`	`return $returnArray;`
`28`	`35`	`}`
`29`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,12 @@`
`4`	`4`
`5`	`5`	`use Vonage\Messages\MessageObjects\ImageObject;`
`6`	`6`	`use Vonage\Messages\Channel\BaseMessage;`
	`7`	`+use Vonage\Messages\MessageTraits\TtlTrait;`
`7`	`8`
`8`	`9`	`class MMSImage extends BaseMessage`
`9`	`10`	`{`
	`11`	`+ use TtlTrait;`
	`12`	`+`
`10`	`13`	`protected string $channel = 'mms';`
`11`	`14`	`protected string $subType = BaseMessage::MESSAGES_SUBTYPE_IMAGE;`
`12`	`15`
`@@ -24,6 +27,10 @@ public function toArray(): array`
`24`	`27`	`$returnArray = $this->getBaseMessageUniversalOutputArray();`
`25`	`28`	`$returnArray['image'] = $this->image->toArray();`
`26`	`29`
	`30`	`+ if (!is_null($this->ttl)) {`
	`31`	`+ $returnArray['ttl'] = $this->ttl;`
	`32`	`+ }`
	`33`	`+`
`27`	`34`	`return $returnArray;`
`28`	`35`	`}`
`29`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,12 @@`
`4`	`4`
`5`	`5`	`use Vonage\Messages\MessageObjects\VCardObject;`
`6`	`6`	`use Vonage\Messages\Channel\BaseMessage;`
	`7`	`+use Vonage\Messages\MessageTraits\TtlTrait;`
`7`	`8`
`8`	`9`	`class MMSvCard extends BaseMessage`
`9`	`10`	`{`
	`11`	`+ use TtlTrait;`
	`12`	`+`
`10`	`13`	`protected string $channel = 'mms';`
`11`	`14`	`protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VCARD;`
`12`	`15`
`@@ -24,6 +27,10 @@ public function toArray(): array`
`24`	`27`	`$returnArray = $this->getBaseMessageUniversalOutputArray();`
`25`	`28`	`$returnArray['vcard'] = $this->vCard->toArray();`
`26`	`29`
	`30`	`+ if (!is_null($this->ttl)) {`
	`31`	`+ $returnArray['ttl'] = $this->ttl;`
	`32`	`+ }`
	`33`	`+`
`27`	`34`	`return $returnArray;`
`28`	`35`	`}`
`29`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,12 @@`
`3`	`3`	`namespace Vonage\Messages\Channel\WhatsApp;`
`4`	`4`
`5`	`5`	`use Vonage\Messages\Channel\BaseMessage;`
	`6`	`+use Vonage\Messages\MessageTraits\ContextTrait;`
`6`	`7`
`7`	`8`	`class WhatsAppCustom extends BaseMessage`
`8`	`9`	`{`
	`10`	`+ use ContextTrait;`
	`11`	`+`
`9`	`12`	`protected string $subType = BaseMessage::MESSAGES_SUBTYPE_CUSTOM;`
`10`	`13`	`protected string $channel = 'whatsapp';`
`11`	`14`
`@@ -33,6 +36,10 @@ public function toArray(): array`
`33`	`36`	`$returnArray = $this->getBaseMessageUniversalOutputArray();`
`34`	`37`	`$returnArray['custom'] = $this->getCustom();`
`35`	`38`
	`39`	`+ if (!is_null($this->context)) {`
	`40`	`+ $returnArray['context'] = $this->context;`
	`41`	`+ }`
	`42`	`+`
`36`	`43`	`return $returnArray;`
`37`	`44`	`}`
`38`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,12 @@`
`4`	`4`
`5`	`5`	`use Vonage\Messages\MessageObjects\FileObject;`
`6`	`6`	`use Vonage\Messages\Channel\BaseMessage;`
	`7`	`+use Vonage\Messages\MessageTraits\ContextTrait;`
`7`	`8`
`8`	`9`	`class WhatsAppFile extends BaseMessage`
`9`	`10`	`{`
	`11`	`+ use ContextTrait;`
	`12`	`+`
`10`	`13`	`protected string $channel = 'whatsapp';`
`11`	`14`	`protected string $subType = BaseMessage::MESSAGES_SUBTYPE_FILE;`
`12`	`15`
`@@ -24,6 +27,10 @@ public function toArray(): array`
`24`	`27`	`$returnArray = $this->getBaseMessageUniversalOutputArray();`
`25`	`28`	`$returnArray['file'] = $this->fileObject->toArray();`
`26`	`29`
	`30`	`+ if (!is_null($this->context)) {`
	`31`	`+ $returnArray['context'] = $this->context;`
	`32`	`+ }`
	`33`	`+`
`27`	`34`	`return $returnArray;`
`28`	`35`	`}`
`29`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,12 @@`
`4`	`4`
`5`	`5`	`use Vonage\Messages\Channel\BaseMessage;`
`6`	`6`	`use Vonage\Messages\Channel\WhatsApp\MessageObjects\StickerObject;`
	`7`	`+use Vonage\Messages\MessageTraits\ContextTrait;`
`7`	`8`
`8`	`9`	`class WhatsAppSticker extends BaseMessage`
`9`	`10`	`{`
	`11`	`+ use ContextTrait;`
	`12`	`+`
`10`	`13`	`protected string $subType = BaseMessage::MESSAGES_SUBTYPE_STICKER;`
`11`	`14`	`protected string $channel = 'whatsapp';`
`12`	`15`
`@@ -36,6 +39,10 @@ public function toArray(): array`
`36`	`39`	`$returnArray = $this->getBaseMessageUniversalOutputArray();`
`37`	`40`	`$returnArray['sticker'] = $this->getSticker()->toArray();`
`38`	`41`
	`42`	`+ if (!is_null($this->context)) {`
	`43`	`+ $returnArray['context'] = $this->context;`
	`44`	`+ }`
	`45`	`+`
`39`	`46`	`return $returnArray;`
`40`	`47`	`}`
`41`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,12 @@`
`5`	`5`	`use Vonage\Messages\MessageObjects\FileObject;`
`6`	`6`	`use Vonage\Messages\MessageObjects\TemplateObject;`
`7`	`7`	`use Vonage\Messages\Channel\BaseMessage;`
	`8`	`+use Vonage\Messages\MessageTraits\ContextTrait;`
`8`	`9`
`9`	`10`	`class WhatsAppTemplate extends BaseMessage`
`10`	`11`	`{`
	`12`	`+ use ContextTrait;`
	`13`	`+`
`11`	`14`	`protected string $channel = 'whatsapp';`
`12`	`15`	`protected string $subType = BaseMessage::MESSAGES_SUBTYPE_TEMPLATE;`
`13`	`16`
`@@ -31,6 +34,10 @@ public function toArray(): array`
`31`	`34`	`]`
`32`	`35`	`];`
`33`	`36`
	`37`	`+ if (!is_null($this->context)) {`
	`38`	`+ $returnArray['context'] = $this->context;`
	`39`	`+ }`
	`40`	`+`
`34`	`41`	`return array_merge($this->getBaseMessageUniversalOutputArray(), $returnArray);`
`35`	`42`	`}`
`36`	`43`