#15: Bot Api Update December 31, 2019

Author: greenplugin

src/Method/Interfaces/HasParseModeVariableInterface.php

@@ -10,5 +10,15 @@
 interface HasParseModeVariableInterface
 {
     public const PARSE_MODE_HTML = 'HTML';
+
+    /**
+     * @see https://core.telegram.org/bots/api#markdownv2-style
+     */
+    public const PARSE_MODE_MARKDOWN_V2 = 'MarkdownV2';
+
+    /**
+     * @deprecated
+     * @see HasParseModeVariableInterface::PARSE_MODE_MARKDOWN_V2
+     */
     public const PARSE_MODE_MARKDOWN = 'Markdown';
 }

src/Method/SetChatAdministratorCustomTitleMethod.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TgBotApi\BotApiBase\Method;
+
+use TgBotApi\BotApiBase\Method\Interfaces\SetMethodAliasInterface;
+use TgBotApi\BotApiBase\Method\Traits\ChatIdVariableTrait;
+use TgBotApi\BotApiBase\Method\Traits\UserIdVariableTrait;
+
+/**
+ * Use this method to set a custom title
+ * for an administrator in a supergroup promoted by the bot. Returns True on success.
+ *
+ * @see https://core.telegram.org/bots/api#setchatadministratorcustomtitle
+ */
+class SetChatAdministratorCustomTitleMethod implements SetMethodAliasInterface
+{
+    use ChatIdVariableTrait;
+    use UserIdVariableTrait;
+
+    /**
+     * @var
+     */
+    public $customTitle;
+
+    /**
+     * @param int|string $chatId
+     */
+    public static function create($chatId, int $userId, string $title): SetChatAdministratorCustomTitleMethod
+    {
+        $instance = new static();
+        $instance->chatId = $chatId;
+        $instance->userId = $userId;
+        $instance->customTitle = $title;
+
+        return $instance;
+    }
+}

src/Traits/SetMethodTrait.php

@@ -6,6 +6,7 @@
 
 use TgBotApi\BotApiBase\Exception\ResponseException;
 use TgBotApi\BotApiBase\Method\Interfaces\SetMethodAliasInterface;
+use TgBotApi\BotApiBase\Method\SetChatAdministratorCustomTitleMethod;
 use TgBotApi\BotApiBase\Method\SetChatDescriptionMethod;
 use TgBotApi\BotApiBase\Method\SetChatPermissionsMethod;
 use TgBotApi\BotApiBase\Method\SetChatPhotoMethod;
@@ -22,116 +23,84 @@
 trait SetMethodTrait
 {
     /**
-     * @param SetMethodAliasInterface $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     abstract public function set(SetMethodAliasInterface $method): bool;
 
     /**
-     * @param SetChatDescriptionMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setChatDescription(SetChatDescriptionMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetChatPhotoMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setChatPhoto(SetChatPhotoMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetChatStickerSetMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
+     */
+    public function setChatAdministrator(SetChatAdministratorCustomTitleMethod $method): bool
+    {
+        return $this->set($method);
+    }
+
+    /**
+     * @throws ResponseException
      */
     public function setChatStickerSet(SetChatStickerSetMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetChatTitleMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setChatTitle(SetChatTitleMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetGameScoreMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setGameScore(SetGameScoreMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetStickerPositionInSetMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setStickerPositionInSet(SetStickerPositionInSetMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetWebhookMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setWebhook(SetWebhookMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetPassportDataErrorsMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setPassportDataErrors(SetPassportDataErrorsMethod $method): bool
     {
         return $this->set($method);
     }
 
     /**
-     * @param SetChatPermissionsMethod $method
-     *
      * @throws ResponseException
-     *
-     * @return bool
      */
     public function setChatPermissions(SetChatPermissionsMethod $method): bool
     {

src/Type/AnimationType.php

@@ -18,6 +18,14 @@ class AnimationType
      */
     public $fileId;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $fileUniqueId;
+
     /**
      * Video width as defined by sender.
      *

src/Type/AudioType.php

@@ -18,6 +18,14 @@ class AudioType
      */
     public $fileId;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $fileUniqueId;
+
     /**
      * Duration of the audio in seconds as defined by sender.
      *

src/Type/ChatMemberType.php

@@ -11,12 +11,12 @@
  */
 class ChatMemberType
 {
-    const STATUS_CREATOR = 'creator';
-    const STATUS_ADMINISTRATOR = 'administrator';
-    const STATUS_MEMBER = 'member';
-    const STATUS_RESTRICTED = 'restricted';
-    const STATUS_LEFT = 'left';
-    const STATUS_KICKED = 'kicked';
+    public const STATUS_CREATOR = 'creator';
+    public const STATUS_ADMINISTRATOR = 'administrator';
+    public const STATUS_MEMBER = 'member';
+    public const STATUS_RESTRICTED = 'restricted';
+    public const STATUS_LEFT = 'left';
+    public const STATUS_KICKED = 'kicked';
 
     /**
      * Information about the user.
@@ -32,6 +32,13 @@ class ChatMemberType
      */
     public $status;
 
+    /**
+     * Optional. Owner and administrators only. Custom title for this user.
+     *
+     * @var string|null
+     */
+    public $customTitle;
+
     /**
      * Optional. Restricted and kicked only. Date when restrictions will be lifted for this user, \DateTimeImmutable.
      *

src/Type/ChatPhotoType.php

@@ -18,10 +18,28 @@ class ChatPhotoType
      */
     public $smallFileId;
 
+    /**
+     * Unique file identifier of small (160x160) chat photo,
+     * which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $smallFileUniqueId;
+
     /**
      * Unique file identifier of big (640x640) chat photo. This file_id can be used only for photo download.
      *
      * @var string
      */
     public $bigFileId;
+
+    /**
+     * Unique file identifier of big (640x640) chat photo,
+     * which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $bigFileUniqueId;
 }

src/Type/ChatType.php

@@ -111,6 +111,14 @@ class ChatType
      */
     public $stickerSetName;
 
+    /**
+     * Optional. For supergroups, the minimum allowed delay between consecutive messages
+     * sent by each unpriviledged user. Returned only in getChat.
+     *
+     * @var int|null
+     */
+    public $slowModeDelay;
+
     /**
      * Optional. True, if the bot can change the group sticker set. Returned only in getChat.
      *

src/Type/DocumentType.php

@@ -18,6 +18,14 @@ class DocumentType
      */
     public $fileId;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $fileUniqueId;
+
     /**
      * Optional. Document thumbnail as defined by sender.
      *

src/Type/FileType.php

@@ -23,6 +23,14 @@ class FileType
      */
     public $fileId;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $fileUniqueId;
+
     /**
      * Optional. File size, if known.
      *

src/Type/MessageEntityType.php

@@ -12,9 +12,11 @@
 class MessageEntityType
 {
     /**
-     * Type of the entity. Can be mention (@username), hashtag, cashtag, bot_command, url, email, phone_number,
-     * bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block),
-     * text_link (for clickable text URLs), text_mention (for users without usernames).
+     * Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD),
+     * “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” ([email protected]),
+     * “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text),
+     * “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block),
+     * “text_link” (for clickable text URLs), “text_mention” (for users without usernames).
      *
      * @var string
      */

src/Type/PassportFileType.php

@@ -18,6 +18,14 @@ class PassportFileType
      */
     public $fileId;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $fileUniqueId;
+
     /**
      * File size.
      *

src/Type/PhotoSizeType.php

@@ -18,6 +18,14 @@ class PhotoSizeType
      */
     public $fileId;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $fileUniqueId;
+
     /**
      * Photo width.
      *

src/Type/StickerType.php

@@ -18,6 +18,14 @@ class StickerType
      */
     public $fileId;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots.
+     * Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    public $fileUniqueId;
+
     /**
      * Sticker width.
      *