Add TransactionPartnerTelegramAds type

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Telegram Bot API for PHP Change Log
 
+## 0.2.1 under development
+
+- New #91: Add `TransactionPartnerTelegramAds` type.
+
 ## 0.2.0 June 29, 2024
 
 - New #16: Add `sendContact` method.

src/Method/SendDocument.php

@@ -18,7 +18,7 @@
 /**
  * @see https://core.telegram.org/bots/api#senddocument
  */
-final readonly class SendDocument implements    TelegramRequestWithResultPreparingInterface
+final readonly class SendDocument implements TelegramRequestWithResultPreparingInterface
 {
     /**
      * @param MessageEntity[]|null $captionEntities

src/Type/Payment/TransactionPartnerFactory.php

@@ -14,6 +14,7 @@ public static function fromTelegramResult(mixed $result): TransactionPartner
         ValueHelper::assertArrayResult($result);
         return match (ValueHelper::getString($result, 'type')) {
             'fragment' => TransactionPartnerFragment::fromTelegramResult($result),
+            'telegram_ads' => TransactionPartnerTelegramAds::fromTelegramResult($result),
             'user' => TransactionPartnerUser::fromTelegramResult($result),
             'other' => TransactionPartnerOther::fromTelegramResult($result),
             default => throw new TelegramParseResultException('Unknown transaction partner type.'),

src/Type/Payment/TransactionPartnerTelegramAds.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Type\Payment;
+
+use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+
+/**
+ * @see https://core.telegram.org/bots/api#transactionpartnertelegramads
+ */
+final readonly class TransactionPartnerTelegramAds implements TransactionPartner
+{
+    public function getType(): string
+    {
+        return 'telegram_ads';
+    }
+
+    public static function fromTelegramResult(mixed $result): self
+    {
+        ValueHelper::assertArrayResult($result);
+        return new self();
+    }
+}

tests/Type/Payment/TransactionPartnerFactoryTest.php

@@ -10,6 +10,7 @@
 use Vjik\TelegramBot\Api\Type\Payment\TransactionPartnerFactory;
 use Vjik\TelegramBot\Api\Type\Payment\TransactionPartnerFragment;
 use Vjik\TelegramBot\Api\Type\Payment\TransactionPartnerOther;
+use Vjik\TelegramBot\Api\Type\Payment\TransactionPartnerTelegramAds;
 use Vjik\TelegramBot\Api\Type\Payment\TransactionPartnerUser;
 
 final class TransactionPartnerFactoryTest extends TestCase
@@ -23,6 +24,12 @@ public static function dataBase(): array
                     'type' => 'fragment',
                 ],
             ],
+            [
+                TransactionPartnerTelegramAds::class,
+                [
+                    'type' => 'telegram_ads',
+                ],
+            ],
             [
                 TransactionPartnerUser::class,
                 [

tests/Type/Payment/TransactionPartnerTelegramAdsTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Type\Payment;
+
+use PHPUnit\Framework\TestCase;
+use Vjik\TelegramBot\Api\ParseResult\TelegramParseResultException;
+use Vjik\TelegramBot\Api\Type\Payment\TransactionPartnerTelegramAds;
+
+final class TransactionPartnerTelegramAdsTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $object = new TransactionPartnerTelegramAds();
+
+        $this->assertSame('telegram_ads', $object->getType());
+    }
+
+    public function testFromTelegramResult(): void
+    {
+        $object = TransactionPartnerTelegramAds::fromTelegramResult([
+            'type' => 'telegram_ads',
+        ]);
+
+        $this->assertSame('telegram_ads', $object->getType());
+    }
+
+    public function testFromTelegramResultWithInvalidResult(): void
+    {
+        $this->expectException(TelegramParseResultException::class);
+        $this->expectExceptionMessage('Expected result as array. Got "string".');
+        TransactionPartnerTelegramAds::fromTelegramResult('hello');
+    }
+}