Update code to reflect latest changes to the Bot API documentation

Author: TiiFuchs

src/Layers/Generated.php

@@ -9,7 +9,7 @@
 use Telepath\Types\Type;
 
 /**
- * This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
+ * This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.
  */
 class InlineKeyboardButton extends Type
 {
@@ -40,7 +40,7 @@ class InlineKeyboardButton extends Type
     /** <em>Optional</em>. Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row. */
     public ?CallbackGame $callback_game = null;
 
-    /** <em>Optional</em>. Specify <em>True</em>, to send a <a href="https://core.telegram.org/bots/api#payments">Pay button</a>.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. */
+    /** <em>Optional</em>. Specify <em>True</em>, to send a <a href="https://core.telegram.org/bots/api#payments">Pay button</a>. Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. */
     public ?bool $pay = null;
 
     /**
@@ -53,7 +53,7 @@ class InlineKeyboardButton extends Type
      * @param  string  $switch_inline_query_current_chat  <em>Optional</em>. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.
      * @param  SwitchInlineQueryChosenChat  $switch_inline_query_chosen_chat  <em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.
      * @param  CallbackGame  $callback_game  <em>Optional</em>. Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row.
-     * @param  bool  $pay  <em>Optional</em>. Specify <em>True</em>, to send a <a href="https://core.telegram.org/bots/api#payments">Pay button</a>.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
+     * @param  bool  $pay  <em>Optional</em>. Specify <em>True</em>, to send a <a href="https://core.telegram.org/bots/api#payments">Pay button</a>. Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
      */
     public static function make(
         string $text,

src/Telegram/InlineKeyboardButton.php

@@ -33,6 +33,9 @@ class InlineQueryResultCachedGif extends InlineQueryResult
      */
     public ?array $caption_entities = null;
 
+    /** <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media */
+    public ?bool $show_caption_above_media = null;
+
     /** <em>Optional</em>. Content of the message to be sent instead of the GIF animation */
     public ?InputMessageContent $input_message_content = null;
 
@@ -43,6 +46,7 @@ class InlineQueryResultCachedGif extends InlineQueryResult
      * @param  string  $caption  <em>Optional</em>. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
      * @param  string  $parse_mode  <em>Optional</em>. Mode for parsing entities in the caption. See <a href="https://core.telegram.org/bots/api#formatting-options">formatting options</a> for more details.
      * @param  MessageEntity[]  $caption_entities  <em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em>
+     * @param  bool  $show_caption_above_media  <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media
      * @param  InlineKeyboardMarkup  $reply_markup  <em>Optional</em>. <a href="https://core.telegram.org/bots/features#inline-keyboards">Inline keyboard</a> attached to the message
      * @param  InputMessageContent  $input_message_content  <em>Optional</em>. Content of the message to be sent instead of the GIF animation
      */
@@ -53,6 +57,7 @@ public static function make(
         ?string $caption = null,
         ?string $parse_mode = null,
         ?array $caption_entities = null,
+        ?bool $show_caption_above_media = null,
         ?InlineKeyboardMarkup $reply_markup = null,
         ?InputMessageContent $input_message_content = null,
     ): static {
@@ -63,6 +68,7 @@ public static function make(
             'caption' => $caption,
             'parse_mode' => $parse_mode,
             'caption_entities' => $caption_entities,
+            'show_caption_above_media' => $show_caption_above_media,
             'reply_markup' => $reply_markup,
             'input_message_content' => $input_message_content,
         ]);

src/Telegram/InlineQueryResultCachedGif.php

@@ -33,6 +33,9 @@ class InlineQueryResultCachedMpeg4Gif extends InlineQueryResult
      */
     public ?array $caption_entities = null;
 
+    /** <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media */
+    public ?bool $show_caption_above_media = null;
+
     /** <em>Optional</em>. Content of the message to be sent instead of the video animation */
     public ?InputMessageContent $input_message_content = null;
 
@@ -43,6 +46,7 @@ class InlineQueryResultCachedMpeg4Gif extends InlineQueryResult
      * @param  string  $caption  <em>Optional</em>. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
      * @param  string  $parse_mode  <em>Optional</em>. Mode for parsing entities in the caption. See <a href="https://core.telegram.org/bots/api#formatting-options">formatting options</a> for more details.
      * @param  MessageEntity[]  $caption_entities  <em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em>
+     * @param  bool  $show_caption_above_media  <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media
      * @param  InlineKeyboardMarkup  $reply_markup  <em>Optional</em>. <a href="https://core.telegram.org/bots/features#inline-keyboards">Inline keyboard</a> attached to the message
      * @param  InputMessageContent  $input_message_content  <em>Optional</em>. Content of the message to be sent instead of the video animation
      */
@@ -53,6 +57,7 @@ public static function make(
         ?string $caption = null,
         ?string $parse_mode = null,
         ?array $caption_entities = null,
+        ?bool $show_caption_above_media = null,
         ?InlineKeyboardMarkup $reply_markup = null,
         ?InputMessageContent $input_message_content = null,
     ): static {
@@ -63,6 +68,7 @@ public static function make(
             'caption' => $caption,
             'parse_mode' => $parse_mode,
             'caption_entities' => $caption_entities,
+            'show_caption_above_media' => $show_caption_above_media,
             'reply_markup' => $reply_markup,
             'input_message_content' => $input_message_content,
         ]);

src/Telegram/InlineQueryResultCachedMpeg4Gif.php

@@ -36,6 +36,9 @@ class InlineQueryResultCachedPhoto extends InlineQueryResult
      */
     public ?array $caption_entities = null;
 
+    /** <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media */
+    public ?bool $show_caption_above_media = null;
+
     /** <em>Optional</em>. Content of the message to be sent instead of the photo */
     public ?InputMessageContent $input_message_content = null;
 
@@ -47,6 +50,7 @@ class InlineQueryResultCachedPhoto extends InlineQueryResult
      * @param  string  $caption  <em>Optional</em>. Caption of the photo to be sent, 0-1024 characters after entities parsing
      * @param  string  $parse_mode  <em>Optional</em>. Mode for parsing entities in the photo caption. See <a href="https://core.telegram.org/bots/api#formatting-options">formatting options</a> for more details.
      * @param  MessageEntity[]  $caption_entities  <em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em>
+     * @param  bool  $show_caption_above_media  <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media
      * @param  InlineKeyboardMarkup  $reply_markup  <em>Optional</em>. <a href="https://core.telegram.org/bots/features#inline-keyboards">Inline keyboard</a> attached to the message
      * @param  InputMessageContent  $input_message_content  <em>Optional</em>. Content of the message to be sent instead of the photo
      */
@@ -58,6 +62,7 @@ public static function make(
         ?string $caption = null,
         ?string $parse_mode = null,
         ?array $caption_entities = null,
+        ?bool $show_caption_above_media = null,
         ?InlineKeyboardMarkup $reply_markup = null,
         ?InputMessageContent $input_message_content = null,
     ): static {
@@ -69,6 +74,7 @@ public static function make(
             'caption' => $caption,
             'parse_mode' => $parse_mode,
             'caption_entities' => $caption_entities,
+            'show_caption_above_media' => $show_caption_above_media,
             'reply_markup' => $reply_markup,
             'input_message_content' => $input_message_content,
         ]);

src/Telegram/InlineQueryResultCachedPhoto.php

@@ -36,6 +36,9 @@ class InlineQueryResultCachedVideo extends InlineQueryResult
      */
     public ?array $caption_entities = null;
 
+    /** <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media */
+    public ?bool $show_caption_above_media = null;
+
     /** <em>Optional</em>. Content of the message to be sent instead of the video */
     public ?InputMessageContent $input_message_content = null;
 
@@ -47,6 +50,7 @@ class InlineQueryResultCachedVideo extends InlineQueryResult
      * @param  string  $caption  <em>Optional</em>. Caption of the video to be sent, 0-1024 characters after entities parsing
      * @param  string  $parse_mode  <em>Optional</em>. Mode for parsing entities in the video caption. See <a href="https://core.telegram.org/bots/api#formatting-options">formatting options</a> for more details.
      * @param  MessageEntity[]  $caption_entities  <em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em>
+     * @param  bool  $show_caption_above_media  <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media
      * @param  InlineKeyboardMarkup  $reply_markup  <em>Optional</em>. <a href="https://core.telegram.org/bots/features#inline-keyboards">Inline keyboard</a> attached to the message
      * @param  InputMessageContent  $input_message_content  <em>Optional</em>. Content of the message to be sent instead of the video
      */
@@ -58,6 +62,7 @@ public static function make(
         ?string $caption = null,
         ?string $parse_mode = null,
         ?array $caption_entities = null,
+        ?bool $show_caption_above_media = null,
         ?InlineKeyboardMarkup $reply_markup = null,
         ?InputMessageContent $input_message_content = null,
     ): static {
@@ -69,6 +74,7 @@ public static function make(
             'caption' => $caption,
             'parse_mode' => $parse_mode,
             'caption_entities' => $caption_entities,
+            'show_caption_above_media' => $show_caption_above_media,
             'reply_markup' => $reply_markup,
             'input_message_content' => $input_message_content,
         ]);

src/Telegram/InlineQueryResultCachedVideo.php

@@ -48,6 +48,9 @@ class InlineQueryResultGif extends InlineQueryResult
      */
     public ?array $caption_entities = null;
 
+    /** <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media */
+    public ?bool $show_caption_above_media = null;
+
     /** <em>Optional</em>. Content of the message to be sent instead of the GIF animation */
     public ?InputMessageContent $input_message_content = null;
 
@@ -63,6 +66,7 @@ class InlineQueryResultGif extends InlineQueryResult
      * @param  string  $caption  <em>Optional</em>. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
      * @param  string  $parse_mode  <em>Optional</em>. Mode for parsing entities in the caption. See <a href="https://core.telegram.org/bots/api#formatting-options">formatting options</a> for more details.
      * @param  MessageEntity[]  $caption_entities  <em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em>
+     * @param  bool  $show_caption_above_media  <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media
      * @param  InlineKeyboardMarkup  $reply_markup  <em>Optional</em>. <a href="https://core.telegram.org/bots/features#inline-keyboards">Inline keyboard</a> attached to the message
      * @param  InputMessageContent  $input_message_content  <em>Optional</em>. Content of the message to be sent instead of the GIF animation
      */
@@ -78,6 +82,7 @@ public static function make(
         ?string $caption = null,
         ?string $parse_mode = null,
         ?array $caption_entities = null,
+        ?bool $show_caption_above_media = null,
         ?InlineKeyboardMarkup $reply_markup = null,
         ?InputMessageContent $input_message_content = null,
     ): static {
@@ -93,6 +98,7 @@ public static function make(
             'caption' => $caption,
             'parse_mode' => $parse_mode,
             'caption_entities' => $caption_entities,
+            'show_caption_above_media' => $show_caption_above_media,
             'reply_markup' => $reply_markup,
             'input_message_content' => $input_message_content,
         ]);

src/Telegram/InlineQueryResultGif.php

@@ -48,6 +48,9 @@ class InlineQueryResultMpeg4Gif extends InlineQueryResult
      */
     public ?array $caption_entities = null;
 
+    /** <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media */
+    public ?bool $show_caption_above_media = null;
+
     /** <em>Optional</em>. Content of the message to be sent instead of the video animation */
     public ?InputMessageContent $input_message_content = null;
 
@@ -63,6 +66,7 @@ class InlineQueryResultMpeg4Gif extends InlineQueryResult
      * @param  string  $caption  <em>Optional</em>. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
      * @param  string  $parse_mode  <em>Optional</em>. Mode for parsing entities in the caption. See <a href="https://core.telegram.org/bots/api#formatting-options">formatting options</a> for more details.
      * @param  MessageEntity[]  $caption_entities  <em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em>
+     * @param  bool  $show_caption_above_media  <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media
      * @param  InlineKeyboardMarkup  $reply_markup  <em>Optional</em>. <a href="https://core.telegram.org/bots/features#inline-keyboards">Inline keyboard</a> attached to the message
      * @param  InputMessageContent  $input_message_content  <em>Optional</em>. Content of the message to be sent instead of the video animation
      */
@@ -78,6 +82,7 @@ public static function make(
         ?string $caption = null,
         ?string $parse_mode = null,
         ?array $caption_entities = null,
+        ?bool $show_caption_above_media = null,
         ?InlineKeyboardMarkup $reply_markup = null,
         ?InputMessageContent $input_message_content = null,
     ): static {
@@ -93,6 +98,7 @@ public static function make(
             'caption' => $caption,
             'parse_mode' => $parse_mode,
             'caption_entities' => $caption_entities,
+            'show_caption_above_media' => $show_caption_above_media,
             'reply_markup' => $reply_markup,
             'input_message_content' => $input_message_content,
         ]);

src/Telegram/InlineQueryResultMpeg4Gif.php

@@ -45,6 +45,9 @@ class InlineQueryResultPhoto extends InlineQueryResult
      */
     public ?array $caption_entities = null;
 
+    /** <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media */
+    public ?bool $show_caption_above_media = null;
+
     /** <em>Optional</em>. Content of the message to be sent instead of the photo */
     public ?InputMessageContent $input_message_content = null;
 
@@ -59,6 +62,7 @@ class InlineQueryResultPhoto extends InlineQueryResult
      * @param  string  $caption  <em>Optional</em>. Caption of the photo to be sent, 0-1024 characters after entities parsing
      * @param  string  $parse_mode  <em>Optional</em>. Mode for parsing entities in the photo caption. See <a href="https://core.telegram.org/bots/api#formatting-options">formatting options</a> for more details.
      * @param  MessageEntity[]  $caption_entities  <em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em>
+     * @param  bool  $show_caption_above_media  <em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media
      * @param  InlineKeyboardMarkup  $reply_markup  <em>Optional</em>. <a href="https://core.telegram.org/bots/features#inline-keyboards">Inline keyboard</a> attached to the message
      * @param  InputMessageContent  $input_message_content  <em>Optional</em>. Content of the message to be sent instead of the photo
      */
@@ -73,6 +77,7 @@ public static function make(
         ?string $caption = null,
         ?string $parse_mode = null,
         ?array $caption_entities = null,
+        ?bool $show_caption_above_media = null,
         ?InlineKeyboardMarkup $reply_markup = null,
         ?InputMessageContent $input_message_content = null,
     ): static {
@@ -87,6 +92,7 @@ public static function make(
             'caption' => $caption,
             'parse_mode' => $parse_mode,
             'caption_entities' => $caption_entities,
+            'show_caption_above_media' => $show_caption_above_media,
             'reply_markup' => $reply_markup,
             'input_message_content' => $input_message_content,
         ]);