Added DialogMuted & BotStopped update types

src/Enums/UpdateType.php

@@ -15,9 +15,14 @@ enum UpdateType: string
     case MessageRemoved = 'message_removed';
     case BotAdded = 'bot_added';
     case BotRemoved = 'bot_removed';
+    case DialogMuted = 'dialog_muted';
+    case DialogUnmuted = 'dialog_unmuted';
+    case DialogCleared = 'dialog_cleared';
+    case DialogRemoved = 'dialog_removed';
     case UserAdded = 'user_added';
     case UserRemoved = 'user_removed';
     case BotStarted = 'bot_started';
+    case BotStopped = 'bot_stopped';
     case ChatTitleChanged = 'chat_title_changed';
     case MessageChatCreated = 'message_chat_created';
 }

src/Laravel/MaxBotManager.php

@@ -229,6 +229,19 @@ class MaxBotManager
         $this->dispatcher->onBotRemoved($this->resolveHandler($handler));
     }
 
+    /**
+     * Register a dialog mute handler.
+     *
+     * @param callable|string $handler Can be a closure, callable, or Laravel container binding.
+     *
+     * @throws BindingResolutionException
+     * @codeCoverageIgnore
+     */
+    public function onDialogMuted(callable|string $handler): void
+    {
+        $this->dispatcher->onDialogMuted($this->resolveHandler($handler));
+    }
+
     /**
      * Register a user added handler.
      *
@@ -268,6 +281,19 @@ class MaxBotManager
         $this->dispatcher->onBotStarted($this->resolveHandler($handler));
     }
 
+    /**
+     * Register a bot stopped handler.
+     *
+     * @param callable|string $handler Can be a closure, callable, or Laravel container binding.
+     *
+     * @throws BindingResolutionException
+     * @codeCoverageIgnore
+     */
+    public function onBotStopped(callable|string $handler): void
+    {
+        $this->dispatcher->onBotStopped($this->resolveHandler($handler));
+    }
+
     /**
      * Register a chat title changed handler.
      *

src/ModelFactory.php

@@ -56,7 +56,9 @@ use BushlanovDev\MaxMessengerBot\Models\Updates\AbstractUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\BotAddedToChatUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\BotRemovedFromChatUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\BotStartedUpdate;
+use BushlanovDev\MaxMessengerBot\Models\Updates\BotStoppedUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\ChatTitleChangedUpdate;
+use BushlanovDev\MaxMessengerBot\Models\Updates\DialogMutedUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\MessageCallbackUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\MessageChatCreatedUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\MessageCreatedUpdate;
@@ -385,9 +387,11 @@ readonly class ModelFactory
             UpdateType::MessageRemoved => MessageRemovedUpdate::fromArray($data),
             UpdateType::BotAdded => BotAddedToChatUpdate::fromArray($data),
             UpdateType::BotRemoved => BotRemovedFromChatUpdate::fromArray($data),
+            UpdateType::DialogMuted => DialogMutedUpdate::fromArray($data),
             UpdateType::UserAdded => UserAddedToChatUpdate::fromArray($data),
             UpdateType::UserRemoved => UserRemovedFromChatUpdate::fromArray($data),
             UpdateType::BotStarted => BotStartedUpdate::fromArray($data),
+            UpdateType::BotStopped => BotStoppedUpdate::fromArray($data),
             UpdateType::ChatTitleChanged => ChatTitleChangedUpdate::fromArray($data),
             UpdateType::MessageChatCreated => MessageChatCreatedUpdate::fromArray($data),
             default => throw new LogicException(

src/Models/Updates/BotStoppedUpdate.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Models\Updates;
+
+use BushlanovDev\MaxMessengerBot\Enums\UpdateType;
+use BushlanovDev\MaxMessengerBot\Models\User;
+
+/**
+ * The bot receives this type of update as soon as the user stops the bot.
+ */
+final readonly class BotStoppedUpdate extends AbstractUpdate
+{
+    /**
+     * @param int $timestamp Unix-time when event has occurred.
+     * @param int $chatId Dialog identifier where event has occurred.
+     * @param User $user User pressed the 'Start' button.
+     * @param string|null $userLocale Current user locale in IETF BCP 47 format.
+     */
+    public function __construct(
+        int $timestamp,
+        public int $chatId,
+        public User $user,
+        public ?string $userLocale,
+    ) {
+        parent::__construct(UpdateType::BotStopped, $timestamp);
+    }
+}

src/Models/Updates/DialogMutedUpdate.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Models\Updates;
+
+use BushlanovDev\MaxMessengerBot\Enums\UpdateType;
+use BushlanovDev\MaxMessengerBot\Models\User;
+
+/**
+ * Event when a user mutes a conversation with a bot.
+ */
+final readonly class DialogMutedUpdate extends AbstractUpdate
+{
+    /**
+     * @param int $timestamp Unix-time when event has occurred.
+     * @param int $chatId Dialog identifier where event has occurred.
+     * @param User $user User pressed the 'Start' button.
+     * @param int|null $mutedUntil The time in Unix format before which the dialog was disabled.
+     * @param string|null $userLocale Current user locale in IETF BCP 47 format.
+     */
+    public function __construct(
+        int $timestamp,
+        public int $chatId,
+        public User $user,
+        public ?int $mutedUntil,
+        public ?string $userLocale,
+    ) {
+        parent::__construct(UpdateType::DialogMuted, $timestamp);
+    }
+}

src/UpdateDispatcher.php

@@ -164,6 +164,19 @@ final class UpdateDispatcher
         return $this->addHandler(UpdateType::BotRemoved, $handler);
     }
 
+    /**
+     * A convenient alias for addHandler(UpdateType::DialogMuted, $handler).
+     *
+     * @param callable(Models\Updates\BotRemovedFromChatUpdate, Api): void $handler
+     *
+     * @return $this
+     * @codeCoverageIgnore
+     */
+    public function onDialogMuted(callable $handler): self
+    {
+        return $this->addHandler(UpdateType::DialogMuted, $handler);
+    }
+
     /**
      * A convenient alias for addHandler(UpdateType::UserAdded, $handler).
      *
@@ -203,6 +216,19 @@ final class UpdateDispatcher
         return $this->addHandler(UpdateType::BotStarted, $handler);
     }
 
+    /**
+     * A convenient alias for addHandler(UpdateType::BotStopped, $handler).
+     *
+     * @param callable(Models\Updates\BotStartedUpdate, Api): void $handler
+     *
+     * @return $this
+     * @codeCoverageIgnore
+     */
+    public function onBotStopped(callable $handler): self
+    {
+        return $this->addHandler(UpdateType::BotStopped, $handler);
+    }
+
     /**
      * A convenient alias for addHandler(UpdateType::ChatTitleChanged, $handler).
      *

tests/Models/Updates/BotStoppedUpdateTest.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Tests\Models\Updates;
+
+use BushlanovDev\MaxMessengerBot\Enums\UpdateType;
+use BushlanovDev\MaxMessengerBot\Models\Updates\BotStoppedUpdate;
+use BushlanovDev\MaxMessengerBot\Models\User;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\Attributes\UsesClass;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(BotStoppedUpdate::class)]
+#[UsesClass(User::class)]
+final class BotStoppedUpdateTest extends TestCase
+{
+    #[Test]
+    public function canBeCreatedFromArray(): void
+    {
+        $data = [
+            'update_type' => UpdateType::BotStopped->value,
+            'timestamp' => 1678886400000,
+            'chat_id' => 123,
+            'user' => [
+                'user_id' => 123,
+                'first_name' => 'John',
+                'last_name' => 'Doe',
+                'is_bot' => false,
+                'last_activity_time' => 1678886400000,
+            ],
+            'user_locale' => 'ru-ru',
+        ];
+
+        $update = BotStoppedUpdate::fromArray($data);
+
+        $this->assertInstanceOf(BotStoppedUpdate::class, $update);
+        $this->assertSame(UpdateType::BotStopped, $update->updateType);
+        $this->assertSame(123, $update->user->userId);
+        $this->assertSame('John', $update->user->firstName);
+        $this->assertSame('Doe', $update->user->lastName);
+        $this->assertSame('ru-ru', $update->userLocale);
+    }
+}

tests/Models/Updates/DialogMutedUpdateTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Tests\Models\Updates;
+
+use BushlanovDev\MaxMessengerBot\Enums\UpdateType;
+use BushlanovDev\MaxMessengerBot\Models\Updates\DialogMutedUpdate;
+use BushlanovDev\MaxMessengerBot\Models\User;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\Attributes\UsesClass;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(DialogMutedUpdate::class)]
+#[UsesClass(User::class)]
+class DialogMutedUpdateTest extends TestCase
+{
+    #[Test]
+    public function canBeCreatedFromArray(): void
+    {
+        $data = [
+            'update_type' => UpdateType::DialogMuted->value,
+            'timestamp' => 1678886400000,
+            'chat_id' => 123,
+            'user' => [
+                'user_id' => 123,
+                'first_name' => 'John',
+                'last_name' => 'Doe',
+                'is_bot' => false,
+                'last_activity_time' => 1678886400000,
+            ],
+            'mutedUntil' => 1678886400000,
+            'user_locale' => 'ru-ru',
+        ];
+
+        $update = DialogMutedUpdate::fromArray($data);
+
+        $this->assertInstanceOf(DialogMutedUpdate::class, $update);
+        $this->assertSame(UpdateType::DialogMuted, $update->updateType);
+        $this->assertSame(123, $update->user->userId);
+        $this->assertSame('John', $update->user->firstName);
+        $this->assertSame('Doe', $update->user->lastName);
+        $this->assertSame('ru-ru', $update->userLocale);
+    }
+}