feat: add msisdnCooldownInMinutes parameter to messages api's (#7)

* feat: add msisdnCooldownInMinutes parameter to messages api's

* Update tests.yml

* Update tests.yml

* test: fix tests

---------

Co-authored-by: Kris Thomsen <[email protected]>

Author: reimarwork

.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        php-versions: ['7.4', '8.0', '8.1', '8.2']
+        php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3']
 
     steps:
       - uses: actions/checkout@v4

src/RequestModels/Message.php

@@ -21,6 +21,7 @@ class Message
     protected string $encoding = self::ENCODING_GSM7;
     protected ?string $messageId = null;
     protected ?string $countryHint = null;
+    protected ?int $msisdnCooldownInMinutes = null;
 
     /**
      * @var mixed
@@ -107,6 +108,13 @@ public function setCountryHint(string $countryHint): self
         return $this;
     }
 
+    public function setMsisdnCooldownInMinutes(?int $msisdnCooldownInMinutes): self
+    {
+        $this->msisdnCooldownInMinutes = $msisdnCooldownInMinutes;
+
+        return $this;
+    }
+
     public function toArray(): array
     {
         return [
@@ -123,6 +131,7 @@ public function toArray(): array
             'respectBlacklist' => $this->respectBlacklist,
             'statusCallbackUrl' => $this->statusCallbackUrl,
             'encoding' => $this->encoding,
+            'msisdnCooldownInMinutes' => $this->msisdnCooldownInMinutes,
         ];
     }
 
@@ -180,4 +189,9 @@ public function getCountryHint(): ?string
     {
         return $this->countryHint;
     }
+
+    public function getMsisdnCooldownInMinutes(): ?int
+    {
+        return $this->msisdnCooldownInMinutes;
+    }
 }

tests/Unit/Endpoints/MessagesApiTest.php

@@ -137,6 +137,7 @@ public function test_sends_a_single_message_with_all_possible_fields()
                         'respectBlacklist' => false,
                         'statusCallbackUrl' => 'https://example.com/inmobile/callback',
                         'encoding' => Message::ENCODING_UCS2,
+                        'msisdnCooldownInMinutes' => null,
                     ], $payload['messages'][0]);
 
                     return true;

tests/Unit/RequestModels/MessageTest.php

@@ -21,7 +21,8 @@ public function test_create_a_message()
             ->flash()
             ->ignoreBlacklist()
             ->setEncoding(Message::ENCODING_GSM7)
-            ->setStatusCallbackUrl('https://example.com/callback');
+            ->setStatusCallbackUrl('https://example.com/callback')
+            ->setMsisdnCooldownInMinutes(60);
 
         $this->assertEquals('Hello World', $message->getText());
         $this->assertEquals(4512345678, $message->getRecipient());
@@ -34,6 +35,7 @@ public function test_create_a_message()
         $this->assertFalse($message->getRespectBlacklist());
         $this->assertEquals(Message::ENCODING_GSM7, $message->getEncoding());
         $this->assertEquals('https://example.com/callback', $message->getStatusCallbackUrl());
+        $this->assertEquals(60, $message->getMsisdnCooldownInMinutes());
     }
 
     public function test_convert_to_array()
@@ -49,7 +51,8 @@ public function test_convert_to_array()
             ->flash()
             ->ignoreBlacklist()
             ->setEncoding(Message::ENCODING_GSM7)
-            ->setStatusCallbackUrl('https://example.com/callback');
+            ->setStatusCallbackUrl('https://example.com/callback')
+            ->setMsisdnCooldownInMinutes(60);
 
         $this->assertEquals([
             'to' => '4512345678',
@@ -63,6 +66,7 @@ public function test_convert_to_array()
             'respectBlacklist' => false,
             'statusCallbackUrl' => 'https://example.com/callback',
             'encoding' => Message::ENCODING_GSM7,
+            'msisdnCooldownInMinutes' => 60,
         ], $message->toArray());
     }
 }