Support for Bot API v4.7

Author: unreal4u

README.md

@@ -10,7 +10,7 @@
 [![License](https://poser.pugx.org/unreal4u/telegram-api/license)](https://packagist.org/packages/unreal4u/telegram-api)
 
 This is a PHP7 bot API implementation for Telegram implementing the **vast majority** of
-[Bot API up until v4.6](https://core.telegram.org/bots/api-changelog#january-23-2020). The only thing it does not implement
+[Bot API up until v4.7](https://core.telegram.org/bots/api-changelog#march-30-2020). The only thing it does not implement
 is Telegram Passport which was introduced in [Bot API v4.0](https://core.telegram.org/bots/api#july-26-2018). It is
 unlikely to be introduced as it may introduce security vulnerabilities. However, if you think you have a strong case for
 the need, feel free to let me know.

src/Telegram/Methods/AddStickerToSet.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace unreal4u\TelegramAPI\Telegram\Methods;
 
@@ -16,7 +16,7 @@
 /**
  * Use this method to add a new sticker to a set created by the bot. Returns True on success
  *
- * Objects defined as-is july 2017
+ * Objects defined as-is June 2020, Bot API v4.9
  *
  * @see https://core.telegram.org/bots/api#addstickertoset
  */
@@ -45,6 +45,14 @@ class AddStickerToSet extends TelegramMethods
      */
     public $png_sticker;
 
+    /**
+     * TGS animation with the sticker, uploaded using multipart/form-data.
+     *
+     * @see https://core.telegram.org/animated_stickers#technical-requirements for technical requirements
+     * @var InputFile
+     */
+    public $tgs_sticker;
+
     /**
      * One or more emoji corresponding to the sticker
      * @var string
@@ -64,21 +72,29 @@ public static function bindToObject(TelegramResponse $data, LoggerInterface $log
 
     public function getMandatoryFields(): array
     {
-        return [
+        $return = [
             'user_id',
             'name',
-            'png_sticker',
             'emojis',
         ];
+
+        // Define property as mandatory when not filled in
+        if (empty($this->png_sticker) && empty($this->tgs_sticker)) {
+            $return[] = 'png_sticker';
+            $return[] = 'tgs_sticker';
+        }
+
+        return $return;
     }
 
     public function hasLocalFiles(): bool
     {
-        return $this->png_sticker instanceof InputFile;
+        return $this->png_sticker instanceof InputFile || $this->tgs_sticker instanceof InputFile;
     }
 
     public function getLocalFiles(): Generator
     {
         yield 'png_sticker' => $this->png_sticker;
+        yield 'tgs_sticker' => $this->tgs_sticker;
     }
 }

src/Telegram/Methods/CreateNewStickerSet.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace unreal4u\TelegramAPI\Telegram\Methods;
 
@@ -17,7 +17,7 @@
  * Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set.
  * Returns True on success
  *
- * Objects defined as-is july 2017
+ * Objects defined as-is June 2020, Bot API v4.9
  *
  * @see https://core.telegram.org/bots/api#createnewstickerset
  */
@@ -52,20 +52,28 @@ class CreateNewStickerSet extends TelegramMethods
      */
     public $png_sticker;
 
+    /**
+     * TGS animation with the sticker, uploaded using multipart/form-data.
+     *
+     * @see https://core.telegram.org/animated_stickers#technical-requirements for technical requirements
+     * @var InputFile
+     */
+    public $tgs_sticker;
+
     /**
      * One or more emoji corresponding to the sticker
      * @var string
      */
     public $emojis = '';
 
     /**
-     * Pass True, if a set of mask stickers should be created
+     * Optional. Pass True, if a set of mask stickers should be created
      * @var bool
      */
-    public $is_masks = false;
+    public $is_masks;
 
     /**
-     * Position where the mask should be placed on faces
+     * Optional. Position where the mask should be placed on faces
      * @var MaskPosition
      */
     public $mask_position;
@@ -77,22 +85,30 @@ public static function bindToObject(TelegramResponse $data, LoggerInterface $log
 
     public function getMandatoryFields(): array
     {
-        return [
+        $return = [
             'user_id',
             'name',
             'title',
-            'png_sticker',
             'emojis',
         ];
+
+        // Define property as mandatory when not filled in
+        if (empty($this->png_sticker) && empty($this->tgs_sticker)) {
+            $return[] = 'png_sticker';
+            $return[] = 'tgs_sticker';
+        }
+
+        return $return;
     }
 
     public function hasLocalFiles(): bool
     {
-        return $this->png_sticker instanceof InputFile;
+        return $this->png_sticker instanceof InputFile || $this->tgs_sticker instanceof InputFile;
     }
 
     public function getLocalFiles(): Generator
     {
         yield 'png_sticker' => $this->png_sticker;
+        yield 'tgs_sticker' => $this->tgs_sticker;
     }
 }

src/Telegram/Methods/GetMyCommands.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace unreal4u\TelegramAPI\Telegram\Methods;
+
+use Psr\Log\LoggerInterface;
+use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
+use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
+use unreal4u\TelegramAPI\InternalFunctionality\TelegramResponse;
+use unreal4u\TelegramAPI\Telegram\Types\Custom\BotCommandArray;
+
+/**
+ * Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of BotCommand on
+ * success.
+ *
+ * Objects defined as-is June 2020, Bot API v4.9
+ *
+ * @see https://core.telegram.org/bots/api#getmycommands
+ */
+class GetMyCommands extends TelegramMethods
+{
+    public static function bindToObject(TelegramResponse $data, LoggerInterface $logger): TelegramTypes
+    {
+        return new BotCommandArray($data->getResult(), $logger);
+    }
+
+    public function getMandatoryFields(): array
+    {
+        return [];
+    }
+}

src/Telegram/Methods/SendDice.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace unreal4u\TelegramAPI\Telegram\Methods;
+
+use unreal4u\TelegramAPI\Abstracts\KeyboardMethods;
+use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
+
+/**
+ * Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
+ *
+ * Objects defined as-is June 2020, Bot API v4.9
+ *
+ * @see https://core.telegram.org/bots/api#senddice
+ */
+class SendDice extends TelegramMethods
+{
+    /**
+     * Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+     * @var string
+     */
+    public $chat_id = '';
+
+    /**
+     * Optional. Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, or “🏀”. Dice can
+     * have values 1-6 for “🎲” and “🎯”, and values 1-5 for “🏀”. Defaults to “🎲”
+     *
+     * @var string
+     */
+    public $emoji = '🎲';
+
+    /**
+     * Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a
+     * notification with no sound.
+     * @see https://telegram.org/blog/channels-2-0#silent-messages
+     * @var bool
+     */
+    public $disable_notification = false;
+
+    /**
+     * If the message is a reply, ID of the original message
+     * @var int
+     */
+    public $reply_to_message_id = 0;
+
+    /**
+     * Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to
+     * hide keyboard or to force a reply from the user.
+     * @var KeyboardMethods
+     */
+    public $reply_markup;
+
+    public function getMandatoryFields(): array
+    {
+        return [
+            'chat_id',
+        ];
+    }
+}

src/Telegram/Methods/SetMyCommands.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace unreal4u\TelegramAPI\Telegram\Methods;
+
+use Psr\Log\LoggerInterface;
+use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
+use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
+use unreal4u\TelegramAPI\InternalFunctionality\TelegramResponse;
+use unreal4u\TelegramAPI\Telegram\Types\BotCommand;
+use unreal4u\TelegramAPI\Telegram\Types\Custom\ResultBoolean;
+
+/**
+ * Use this method to change the list of the bot's commands. Returns True on success.
+ *
+ * Objects defined as-is June 2020, Bot API v4.9
+ *
+ * @see https://core.telegram.org/bots/api#setmycommands
+ */
+class SetMyCommands extends TelegramMethods
+{
+    /**
+     * A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be
+     * specified.
+     *
+     * @var BotCommand[]
+     */
+    public $commands;
+
+    public static function bindToObject(TelegramResponse $data, LoggerInterface $logger): TelegramTypes
+    {
+        return new ResultBoolean($data->getResultBoolean(), $logger);
+    }
+
+    public function getMandatoryFields(): array
+    {
+        return [
+            'commands',
+        ];
+    }
+
+    public function performSpecialConditions(): TelegramMethods
+    {
+        $this->commands = json_encode($this->commands);
+        return parent::performSpecialConditions();
+    }
+}

src/Telegram/Methods/SetStickerSetThumb.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace unreal4u\TelegramAPI\Telegram\Methods;
+
+use Generator;
+use Psr\Log\LoggerInterface;
+use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
+use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
+use unreal4u\TelegramAPI\InternalFunctionality\TelegramResponse;
+use unreal4u\TelegramAPI\Telegram\Types\Custom\InputFile;
+use unreal4u\TelegramAPI\Telegram\Types\Custom\ResultBoolean;
+
+/**
+ * Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only.
+ * Returns True on success.
+ *
+ * Objects defined as-is June 2020, Bot API v4.9
+ *
+ * @see https://core.telegram.org/bots/api#setstickersetthumb
+ */
+class SetStickerSetThumb extends TelegramMethods
+{
+    /**
+     * Sticker set name
+     * @var string
+     */
+    public $name;
+
+    /**
+     * User identifier of the sticker set owner
+     * @var int
+     */
+    public $user_id;
+
+    /**
+     * A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a
+     * TGS animation with the thumbnail up to 32 kilobytes in size; see
+     * https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements.
+     * Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a
+     * String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on
+     * Sending Files ». Animated sticker set thumbnail can't be uploaded via HTTP URL.
+     *
+     * @var InputFile|string
+     */
+    public $thumb;
+
+    public static function bindToObject(TelegramResponse $data, LoggerInterface $logger): TelegramTypes
+    {
+        return new ResultBoolean($data->getResultBoolean(), $logger);
+    }
+
+    public function getMandatoryFields(): array
+    {
+        return [
+            'name',
+            'user_id',
+        ];
+    }
+
+    public function hasLocalFiles(): bool
+    {
+        return $this->thumb instanceof InputFile;
+    }
+
+    public function getLocalFiles(): Generator
+    {
+        yield 'thumb' => $this->thumb;
+    }
+}