Telegram Bot API 8.2 support (#129)

vjik · Jan 2, 2025 · 67527f8 · 67527f8
1 parent d998207
commit 67527f8
Show file tree

Hide file tree

Showing 18 changed files with 467 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Telegram Bot API for PHP Change Log
 
+## 0.5.0 January 02, 2025
+
+- New #129: Add `verifyUser`, `verifyChat`, `removeUserVerification` and `removeChatVerification` methods.
+- New #129: Add `upgradeStarCount` field to `Gift` type.
+- New #129: Add `payForUpgrade` parameter to `SendGift` method.
+- Chg #129: Remove `hideUrl` field from `InlineQueryResultArticle` type.
+
 ## 0.4.7.1 December 18, 2024
 
 - Bug #128: Add a check for a seekable response body and rewind in `PsrTelegramClient`.

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 
 The package provides a simple and convenient way to interact with the Telegram Bot API.
 
-✔️ Telegram Bot API 8.1 (December 4, 2024) is **fully supported**.
+✔️ Telegram Bot API 8.2 (January 1, 2025) is **fully supported**.
 
 ## Requirements
 

diff --git a/src/Method/RemoveChatVerification.php b/src/Method/RemoveChatVerification.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Method;
+
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
+
+/**
+ * @see https://core.telegram.org/bots/api#removechatverification
+ *
+ * @template-implements TelegramRequestWithResultPreparingInterface<TrueValue>
+ */
+final readonly class RemoveChatVerification implements TelegramRequestWithResultPreparingInterface
+{
+    public function __construct(
+        private int|string $chatId,
+    ) {}
+
+    public function getHttpMethod(): HttpMethod
+    {
+        return HttpMethod::POST;
+    }
+
+    public function getApiMethod(): string
+    {
+        return 'removeChatVerification';
+    }
+
+    public function getData(): array
+    {
+        return [
+            'chat_id' => $this->chatId,
+        ];
+    }
+
+    public function getResultType(): TrueValue
+    {
+        return new TrueValue();
+    }
+}
diff --git a/src/Method/RemoveUserVerification.php b/src/Method/RemoveUserVerification.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Method;
+
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
+
+/**
+ * @see https://core.telegram.org/bots/api#removeuserverification
+ *
+ * @template-implements TelegramRequestWithResultPreparingInterface<TrueValue>
+ */
+final readonly class RemoveUserVerification implements TelegramRequestWithResultPreparingInterface
+{
+    public function __construct(
+        private int $userId,
+    ) {}
+
+    public function getHttpMethod(): HttpMethod
+    {
+        return HttpMethod::POST;
+    }
+
+    public function getApiMethod(): string
+    {
+        return 'removeUserVerification';
+    }
+
+    public function getData(): array
+    {
+        return [
+            'user_id' => $this->userId,
+        ];
+    }
+
+    public function getResultType(): TrueValue
+    {
+        return new TrueValue();
+    }
+}
diff --git a/src/Method/Sticker/SendGift.php b/src/Method/Sticker/SendGift.php
@@ -25,6 +25,7 @@ public function __construct(
         private ?string $text = null,
         private ?string $textParseMode = null,
         private ?array $textEntities = null,
+        private ?bool $payForUpgrade = null,
     ) {}
 
     public function getHttpMethod(): HttpMethod
@@ -43,6 +44,7 @@ public function getData(): array
             [
                 'user_id' => $this->userId,
                 'gift_id' => $this->giftId,
+                'pay_for_upgrade' => $this->payForUpgrade,
                 'text' => $this->text,
                 'text_parse_mode' => $this->textParseMode,
                 'text_entities' => $this->textEntities === null

diff --git a/src/Method/VerifyChat.php b/src/Method/VerifyChat.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Method;
+
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
+
+/**
+ * @see https://core.telegram.org/bots/api#verifychat
+ *
+ * @template-implements TelegramRequestWithResultPreparingInterface<TrueValue>
+ */
+final readonly class VerifyChat implements TelegramRequestWithResultPreparingInterface
+{
+    public function __construct(
+        private int|string $chatId,
+        private ?string $customDescription = null,
+    ) {}
+
+    public function getHttpMethod(): HttpMethod
+    {
+        return HttpMethod::POST;
+    }
+
+    public function getApiMethod(): string
+    {
+        return 'verifyChat';
+    }
+
+    public function getData(): array
+    {
+        return array_filter(
+            [
+                'chat_id' => $this->chatId,
+                'custom_description' => $this->customDescription,
+            ],
+            static fn(mixed $value): bool => $value !== null,
+        );
+    }
+
+    public function getResultType(): TrueValue
+    {
+        return new TrueValue();
+    }
+}
diff --git a/src/Method/VerifyUser.php b/src/Method/VerifyUser.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Method;
+
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
+
+/**
+ * @see https://core.telegram.org/bots/api#verifyuser
+ *
+ * @template-implements TelegramRequestWithResultPreparingInterface<TrueValue>
+ */
+final readonly class VerifyUser implements TelegramRequestWithResultPreparingInterface
+{
+    public function __construct(
+        private int $userId,
+        private ?string $customDescription = null,
+    ) {}
+
+    public function getHttpMethod(): HttpMethod
+    {
+        return HttpMethod::POST;
+    }
+
+    public function getApiMethod(): string
+    {
+        return 'verifyUser';
+    }
+
+    public function getData(): array
+    {
+        return array_filter(
+            [
+                'user_id' => $this->userId,
+                'custom_description' => $this->customDescription,
+            ],
+            static fn(mixed $value): bool => $value !== null,
+        );
+    }
+
+    public function getResultType(): TrueValue
+    {
+        return new TrueValue();
+    }
+}
diff --git a/src/TelegramBotApi.php b/src/TelegramBotApi.php
@@ -68,6 +68,8 @@
 use Vjik\TelegramBot\Api\Method\Payment\SendInvoice;
 use Vjik\TelegramBot\Api\Method\PinChatMessage;
 use Vjik\TelegramBot\Api\Method\PromoteChatMember;
+use Vjik\TelegramBot\Api\Method\RemoveChatVerification;
+use Vjik\TelegramBot\Api\Method\RemoveUserVerification;
 use Vjik\TelegramBot\Api\Method\ReopenForumTopic;
 use Vjik\TelegramBot\Api\Method\ReopenGeneralForumTopic;
 use Vjik\TelegramBot\Api\Method\RestrictChatMember;
@@ -136,6 +138,8 @@
 use Vjik\TelegramBot\Api\Method\UpdatingMessage\EditMessageText;
 use Vjik\TelegramBot\Api\Method\UpdatingMessage\StopMessageLiveLocation;
 use Vjik\TelegramBot\Api\Method\UpdatingMessage\StopPoll;
+use Vjik\TelegramBot\Api\Method\VerifyChat;
+use Vjik\TelegramBot\Api\Method\VerifyUser;
 use Vjik\TelegramBot\Api\ParseResult\ResultFactory;
 use Vjik\TelegramBot\Api\ParseResult\TelegramParseResultException;
 use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\ValueProcessorInterface;
@@ -1303,6 +1307,26 @@ public function refundStarPayment(int $userId, string $telegramPaymentChargeId):
         );
     }
 
+    /**
+     * @see https://core.telegram.org/bots/api#removechatverification
+     */
+    public function removeChatVerification(int|string $chatId): FailResult|true
+    {
+        return $this->send(
+            new RemoveChatVerification($chatId),
+        );
+    }
+
+    /**
+     * @see https://core.telegram.org/bots/api#removeuserverification
+     */
+    public function removeUserVerification(int $userId): FailResult|true
+    {
+        return $this->send(
+            new RemoveUserVerification($userId),
+        );
+    }
+
     /**
      * @see https://core.telegram.org/bots/api#reopenforumtopic
      */
@@ -1655,6 +1679,7 @@ public function sendGift(
         ?string $text = null,
         ?string $textParseMode = null,
         ?array $textEntities = null,
+        ?bool $payForUpgrade = null,
     ): FailResult|true {
         return $this->send(
             new SendGift(
@@ -1663,6 +1688,7 @@ public function sendGift(
                 $text,
                 $textParseMode,
                 $textEntities,
+                $payForUpgrade,
             ),
         );
     }
@@ -2607,6 +2633,26 @@ public function uploadStickerFile(int $userId, InputFile $sticker, string $stick
         );
     }
 
+    /**
+     * @see https://core.telegram.org/bots/api#verifychat
+     */
+    public function verifyChat(int|string $chatId, ?string $customDescription = null): FailResult|true
+    {
+        return $this->send(
+            new VerifyChat($chatId, $customDescription),
+        );
+    }
+
+    /**
+     * @see https://core.telegram.org/bots/api#verifyuser
+     */
+    public function verifyUser(int $userId, ?string $customDescription = null): FailResult|true
+    {
+        return $this->send(
+            new VerifyUser($userId, $customDescription),
+        );
+    }
+
     /**
      * @psalm-template TClass as object
      * @psalm-template TValue as mixed

diff --git a/src/Type/Inline/InlineQueryResultArticle.php b/src/Type/Inline/InlineQueryResultArticle.php
@@ -17,7 +17,6 @@ public function __construct(
         public InputMessageContent $inputMessageContent,
         public ?InlineKeyboardMarkup $replyMarkup = null,
         public ?string $url = null,
-        public ?bool $hideUrl = null,
         public ?string $description = null,
         public ?string $thumbnailUrl = null,
         public ?int $thumbnailWidth = null,
@@ -39,7 +38,6 @@ public function toRequestArray(): array
                 'input_message_content' => $this->inputMessageContent->toRequestArray(),
                 'reply_markup' => $this->replyMarkup?->toRequestArray(),
                 'url' => $this->url,
-                'hide_url' => $this->hideUrl,
                 'description' => $this->description,
                 'thumbnail_url' => $this->thumbnailUrl,
                 'thumbnail_width' => $this->thumbnailWidth,

diff --git a/src/Type/Sticker/Gift.php b/src/Type/Sticker/Gift.php
@@ -15,5 +15,6 @@ public function __construct(
         public int $starCount,
         public ?int $totalCount = null,
         public ?int $remainingCount = null,
+        public ?int $upgradeStarCount = null,
     ) {}
 }
diff --git a/tests/Method/RemoveChatVerificationTest.php b/tests/Method/RemoveChatVerificationTest.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Tests\Method;
+
+use PHPUnit\Framework\TestCase;
+use Vjik\TelegramBot\Api\Method\RemoveChatVerification;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Tests\Support\TestHelper;
+
+final class RemoveChatVerificationTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $method = new RemoveChatVerification(7);
+
+        $this->assertSame(HttpMethod::POST, $method->getHttpMethod());
+        $this->assertSame('removeChatVerification', $method->getApiMethod());
+        $this->assertSame(
+            [
+                'chat_id' => 7,
+            ],
+            $method->getData(),
+        );
+    }
+
+    public function testPrepareResult(): void
+    {
+        $method = new RemoveChatVerification('id5');
+
+        $preparedResult = TestHelper::createSuccessStubApi(true)->send($method);
+
+        $this->assertTrue($preparedResult);
+    }
+}