Added editBotInfo & editChat & getVideoAttachmentDetails

Author: BushlanovDev

README.md

@@ -2,16 +2,14 @@
 
 [![Actions status](https://github.com/BushlanovDev/max-bot-api-client-php/actions/workflows/ci.yml/badge.svg?style=flat-square)](https://github.com/BushlanovDev/max-bot-api-client-php/actions)
 [![Coverage](https://raw.githubusercontent.com/BushlanovDev/max-bot-api-client-php/refs/heads/master/badge-coverage.svg?v=1)](https://github.com/BushlanovDev/max-bot-api-client-php/actions)
+[![Packagist Version](https://img.shields.io/packagist/v/bushlanov-dev/max-bot-api-client-php.svg?style=flat-square)](https://packagist.org/packages/bushlanov-dev/max-bot-api-client-php)
 [![PHP version](https://img.shields.io/badge/php-%3E%3D%208.3-8892BF.svg?style=flat-square)](https://github.com/BushlanovDev/max-bot-api-client-php)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
 > [!CAUTION]  
 > На мой взгляд `Max Messenger` является ни чем иным как малварью, созданной для слежки за гражданами РФ. Настоятельно
 > не рекомендую использовать его на реальных устройствах, с настоящим номером телефона, и для личной переписки.
 
-> [!IMPORTANT]  
-> Библиотека в стадии активной разработки.
-
 ## Быстрый старт
 
 > Если вы новичок, то можете прочитать [официальную документацию](https://dev.max.ru/), написанную разработчиками Max.
@@ -81,14 +79,14 @@ $webhookHandler->addHandler(UpdateType::BotStarted, function (BotStartedUpdate $
 #### Bots
 
 - [x] `GET /me` (`getBotInfo`) - *Получение информации о боте.*
-- [ ] `PATCH /me` (`editBotInfo`) - *Редактирование информации о боте.*
+- [x] `PATCH /me` (`editBotInfo`) - *Редактирование информации о боте.*
 
 #### Chats
 
 - [x] `GET /chats` (`getChats`) - *Получение списка всех чатов бота.*
 - [x] `GET /chats/{chatLink}` (`getChatByLink`) - *Получение информации о чате по ссылке.*
 - [x] `GET /chats/{chatId}` (`getChat`) - *Получение информации о чате по ID.*
-- [ ] `PATCH /chats/{chatId}` (`editChat`) - *Редактирование информации о чате.*
+- [x] `PATCH /chats/{chatId}` (`editChat`) - *Редактирование информации о чате.*
 - [x] `DELETE /chats/{chatId}` (`deleteChat`) - *Удаление чата.*
 - [x] `POST /chats/{chatId}/actions` (`sendAction`) - *Отправка действия в чат (например, "печатает...").*
 - [x] `GET /chats/{chatId}/pin` (`getPinnedMessage`) - *Получение закрепленного сообщения.*
@@ -121,7 +119,7 @@ $webhookHandler->addHandler(UpdateType::BotStarted, function (BotStartedUpdate $
 - [x] `PUT /messages` (`editMessage`) - *Редактирование сообщения.*
 - [x] `DELETE /messages` (`deleteMessage`) - *Удаление сообщения.*
 - [x] `GET /messages/{messageId}` (`getMessageById`) - *Получение сообщения по ID.*
-- [ ] `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - *Получение детальной информации о видео.*
+- [x] `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - *Получение детальной информации о видео.*
 - [x] `POST /answers` (`answerOnCallback`) - *Ответ на нажатие callback-кнопки.*
 
 ## Лицензия

src/Api.php

@@ -19,18 +19,21 @@
 use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\PhotoAttachmentRequest;
 use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\VideoAttachmentRequest;
 use BushlanovDev\MaxMessengerBot\Models\BotInfo;
+use BushlanovDev\MaxMessengerBot\Models\BotPatch;
 use BushlanovDev\MaxMessengerBot\Models\Chat;
 use BushlanovDev\MaxMessengerBot\Models\ChatAdmin;
 use BushlanovDev\MaxMessengerBot\Models\ChatList;
 use BushlanovDev\MaxMessengerBot\Models\ChatMember;
 use BushlanovDev\MaxMessengerBot\Models\ChatMembersList;
+use BushlanovDev\MaxMessengerBot\Models\ChatPatch;
 use BushlanovDev\MaxMessengerBot\Models\Message;
 use BushlanovDev\MaxMessengerBot\Models\MessageLink;
 use BushlanovDev\MaxMessengerBot\Models\Result;
 use BushlanovDev\MaxMessengerBot\Models\Subscription;
 use BushlanovDev\MaxMessengerBot\Models\UpdateList;
 use BushlanovDev\MaxMessengerBot\Models\Updates\AbstractUpdate;
 use BushlanovDev\MaxMessengerBot\Models\UploadEndpoint;
+use BushlanovDev\MaxMessengerBot\Models\VideoAttachmentDetails;
 use InvalidArgumentException;
 use LogicException;
 use Psr\Http\Message\ServerRequestInterface;
@@ -51,7 +54,7 @@ class Api
     private const string METHOD_GET = 'GET';
     private const string METHOD_POST = 'POST';
     private const string METHOD_DELETE = 'DELETE';
-//    private const string METHOD_PATCH = 'PATCH';
+    private const string METHOD_PATCH = 'PATCH';
     private const string METHOD_PUT = 'PUT';
 
     private const string ACTION_ME = '/me';
@@ -67,6 +70,7 @@ class Api
     private const string ACTION_CHATS_MEMBERS = '/chats/%d/members';
     private const string ACTION_UPDATES = '/updates';
     private const string ACTION_ANSWERS = '/answers';
+    private const string ACTION_VIDEO_DETAILS = '/videos/%s';
 
     private readonly ClientApiInterface $client;
 
@@ -1068,6 +1072,81 @@ public function editMessage(
         );
     }
 
+    /**
+     * Edits the bot info.
+     *
+     * Example: editBotInfo(new BotPatch(name: 'New Bot Name', description: null));
+     *
+     * @param BotPatch $botPatch
+     *
+     * @return BotInfo
+     * @throws ClientApiException
+     * @throws NetworkException
+     * @throws ReflectionException
+     * @throws SerializationException
+     */
+    public function editBotInfo(BotPatch $botPatch): BotInfo
+    {
+        return $this->modelFactory->createBotInfo(
+            $this->client->request(
+                self::METHOD_PATCH,
+                self::ACTION_ME,
+                [],
+                $botPatch->toArray(),
+            )
+        );
+    }
+
+    /**
+     * Edits chat info such as title, icon, etc.
+     * Instantiate ChatPatch with named arguments for the fields you want to change.
+     *
+     * Example:
+     * $patch = new ChatPatch(title: 'New Cool Title');
+     * $api->editChat(12345, $patch);
+     *
+     * @param int $chatId The identifier of the chat to edit.
+     * @param ChatPatch $chatPatch An object containing the fields to update.
+     *
+     * @return Chat
+     * @throws ClientApiException
+     * @throws NetworkException
+     * @throws ReflectionException
+     * @throws SerializationException
+     */
+    public function editChat(int $chatId, ChatPatch $chatPatch): Chat
+    {
+        return $this->modelFactory->createChat(
+            $this->client->request(
+                self::METHOD_PATCH,
+                self::ACTION_CHATS . '/' . $chatId,
+                [],
+                $chatPatch->toArray(),
+            )
+        );
+    }
+
+    /**
+     * Returns detailed information about a video attachment, including playback URLs.
+     *
+     * @param string $videoToken The token of the video attachment.
+     *
+     * @return VideoAttachmentDetails
+     * @throws ClientApiException
+     * @throws NetworkException
+     * @throws ReflectionException
+     * @throws SerializationException
+     */
+    public function getVideoAttachmentDetails(string $videoToken): VideoAttachmentDetails
+    {
+        return $this->modelFactory->createVideoAttachmentDetails(
+            $this->client->request(
+                self::METHOD_GET,
+                sprintf(self::ACTION_VIDEO_DETAILS, $videoToken),
+            )
+        );
+    }
+
     /**
      * A helper to build the 'NewMessageBody' array structure consistently.
      *

src/ModelFactory.php

@@ -27,6 +27,7 @@
 use BushlanovDev\MaxMessengerBot\Models\Updates\UserAddedToChatUpdate;
 use BushlanovDev\MaxMessengerBot\Models\Updates\UserRemovedFromChatUpdate;
 use BushlanovDev\MaxMessengerBot\Models\UploadEndpoint;
+use BushlanovDev\MaxMessengerBot\Models\VideoAttachmentDetails;
 use LogicException;
 use ReflectionException;
 
@@ -234,4 +235,17 @@ public function createChatMembersList(array $data): ChatMembersList
     {
         return ChatMembersList::fromArray($data);
     }
+
+    /**
+     * Creates a VideoAttachmentDetails object from raw API data.
+     *
+     * @param array<string, mixed> $data
+     *
+     * @return VideoAttachmentDetails
+     * @throws ReflectionException
+     */
+    public function createVideoAttachmentDetails(array $data): VideoAttachmentDetails
+    {
+        return VideoAttachmentDetails::fromArray($data);
+    }
 }

src/Models/AbstractModel.php

@@ -42,6 +42,65 @@ public static function fromArray(array $data): static
         return new static(...$constructorArgs); // @phpstan-ignore-line
     }
 
+    /**
+     * @return array<string, mixed>
+     * @throws ReflectionException
+     */
+    public function toArray(): array
+    {
+        $reflectionClass = new ReflectionClass($this);
+        $properties = $reflectionClass->getProperties(ReflectionProperty::IS_PUBLIC);
+        $result = [];
+
+        foreach ($properties as $property) {
+            if (!$property->isInitialized($this)) {
+                continue;
+            }
+
+            $phpPropertyName = $property->getName();
+            $value = $property->getValue($this);
+
+            $jsonKey = self::toSnakeCase($phpPropertyName);
+
+            $result[$jsonKey] = $this->convertValue($value);
+        }
+
+        return $result;
+    }
+
+    /**
+     * @param string $input
+     *
+     * @return string
+     */
+    protected static function toSnakeCase(string $input): string
+    {
+        return strtolower((string)preg_replace('/(?<!^)[A-Z]/', '_$0', $input));
+    }
+
+    /**
+     * @param mixed $value
+     *
+     * @return mixed
+     * @throws ReflectionException
+     */
+    protected function convertValue(mixed $value): mixed
+    {
+        if ($value instanceof AbstractModel) {
+            return $value->toArray();
+        }
+
+        if (is_array($value)) {
+            return array_map([$this, 'convertValue'], $value);
+        }
+
+        if ($value instanceof BackedEnum) {
+            return $value->value;
+        }
+
+        return $value;
+    }
+
     /**
      * @param mixed $value
      * @param ReflectionProperty $property
@@ -114,63 +173,4 @@ private static function castArray(mixed $value, ReflectionProperty $property): a
 
         return $value;
     }
-
-    /**
-     * @param string $input
-     *
-     * @return string
-     */
-    private static function toSnakeCase(string $input): string
-    {
-        return strtolower((string)preg_replace('/(?<!^)[A-Z]/', '_$0', $input));
-    }
-
-    /**
-     * @return array<string, mixed>
-     * @throws ReflectionException
-     */
-    public function toArray(): array
-    {
-        $reflectionClass = new ReflectionClass($this);
-        $properties = $reflectionClass->getProperties(ReflectionProperty::IS_PUBLIC);
-        $result = [];
-
-        foreach ($properties as $property) {
-            if (!$property->isInitialized($this)) {
-                continue;
-            }
-
-            $phpPropertyName = $property->getName();
-            $value = $property->getValue($this);
-
-            $jsonKey = self::toSnakeCase($phpPropertyName);
-
-            $result[$jsonKey] = $this->convertValue($value);
-        }
-
-        return $result;
-    }
-
-    /**
-     * @param mixed $value
-     *
-     * @return mixed
-     * @throws ReflectionException
-     */
-    private function convertValue(mixed $value): mixed
-    {
-        if ($value instanceof AbstractModel) {
-            return $value->toArray();
-        }
-
-        if (is_array($value)) {
-            return array_map([$this, 'convertValue'], $value);
-        }
-
-        if ($value instanceof BackedEnum) {
-            return $value->value;
-        }
-
-        return $value;
-    }
 }

src/Models/AbstractPatchModel.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Models;
+
+/**
+ * An abstract base for PATCH request models. It uses a variadic constructor
+ * to capture named arguments, tracking which fields were explicitly set.
+ */
+abstract readonly class AbstractPatchModel extends AbstractModel
+{
+    /**
+     * @var array<int|string, mixed>
+     */
+    protected array $patchData;
+
+    /**
+     * Captures all passed named arguments into an associative array.
+     *
+     * @param mixed ...$params
+     */
+    public function __construct(...$params)
+    {
+        $this->patchData = $params;
+    }
+
+    /**
+     * @return array<string, mixed>
+     * @throws \ReflectionException
+     */
+    final public function toArray(): array
+    {
+        $result = [];
+        foreach ($this->patchData as $key => $value) {
+            $jsonKey = $this->toSnakeCase((string)$key);
+            $result[$jsonKey] = $this->convertValue($value);
+        }
+
+        return $result;
+    }
+}

src/Models/BotPatch.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Models;
+
+use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\PhotoAttachmentRequestPayload;
+
+/**
+ * Represents the data to patch for a bot. Instantiate with named arguments.
+ *
+ * Example: new BotPatch(name: 'New Bot Name', description: null);
+ *
+ * @property-read string|null $name
+ * @property-read string|null $description
+ * @property-read BotCommand[]|null $commands
+ * @property-read PhotoAttachmentRequestPayload|null $photo
+ */
+final readonly class BotPatch extends AbstractPatchModel
+{
+}