Telegram Bot API August 18, 2023 updates (v6.8)

Author: johnspade

README.md

@@ -1,6 +1,6 @@
 # F[Tg] - Telegramium
 
-[![Telegram](https://img.shields.io/badge/Telegram%20Bot%20API-6.7%20(April%2021%2C%202023)-blue)](https://core.telegram.org/bots/api#recent-changes)
+[![Telegram](https://img.shields.io/badge/Telegram%20Bot%20API-6.8%20(August%2018%2C%202023)-blue)](https://core.telegram.org/bots/api#recent-changes)
 [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.apimorphism/telegramium-core_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.apimorphism/telegramium-core_2.13)
 

build.sbt

@@ -1,7 +1,7 @@
 enablePlugins(GitPlugin)
 
 ThisBuild / version := Version.mkVersion(
-  "8.67.2",
+  "8.68.0",
   git.gitCurrentBranch.value,
   git.gitDescribedVersion.value,
   git.gitUncommittedChanges.value

telegramium-core/src/main/scala/telegramium/bots/Chat.scala

@@ -25,6 +25,9 @@ package telegramium.bots
   *   Returned only in getChat.
   * @param emojiStatusCustomEmojiId
   *   Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.
+  * @param emojiStatusExpirationDate
+  *   Optional. Expiration date of the emoji status of the other party in a private chat, if any. Returned only in
+  *   getChat.
   * @param bio
   *   Optional. Bio of the other party in a private chat. Returned only in getChat.
   * @param hasPrivateForwards
@@ -83,6 +86,7 @@ final case class Chat(
   photo: Option[ChatPhoto] = Option.empty,
   activeUsernames: List[String] = List.empty,
   emojiStatusCustomEmojiId: Option[String] = Option.empty,
+  emojiStatusExpirationDate: Option[Int] = Option.empty,
   bio: Option[String] = Option.empty,
   hasPrivateForwards: Option[Boolean] = Option.empty,
   hasRestrictedVoiceAndVideoMessages: Option[Boolean] = Option.empty,

telegramium-core/src/main/scala/telegramium/bots/InlineKeyboardButton.scala

@@ -19,9 +19,7 @@ package telegramium.bots
   * @param switchInlineQuery
   *   Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert
   *   the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's
-  *   username will be inserted. Note: This offers an easy way for users to start using your bot in inline mode when
-  *   they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this
-  *   case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.
+  *   username will be inserted.
   * @param switchInlineQueryCurrentChat
   *   Optional. 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

telegramium-core/src/main/scala/telegramium/bots/Message.scala

@@ -67,6 +67,8 @@ package telegramium.bots
   *   Optional. Message is a photo, available sizes of the photo
   * @param sticker
   *   Optional. Message is a sticker, information about the sticker
+  * @param story
+  *   Optional. Message is a forwarded story
   * @param video
   *   Optional. Message is a video, information about the video
   * @param videoNote
@@ -199,6 +201,7 @@ final case class Message(
   document: Option[Document] = Option.empty,
   photo: List[PhotoSize] = List.empty,
   sticker: Option[Sticker] = Option.empty,
+  story: Option[Story.type] = Option.empty,
   video: Option[Video] = Option.empty,
   videoNote: Option[VideoNote] = Option.empty,
   voice: Option[Voice] = Option.empty,

telegramium-core/src/main/scala/telegramium/bots/PollAnswer.scala

@@ -4,9 +4,16 @@ package telegramium.bots
   *
   * @param pollId
   *   Unique poll identifier
+  * @param voterChat
+  *   Optional. The chat that changed the answer to the poll, if the voter is anonymous
   * @param user
-  *   The user, who changed the answer to the poll
+  *   Optional. The user that changed the answer to the poll, if the voter isn't anonymous
   * @param optionIds
-  *   0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.
+  *   0-based identifiers of chosen answer options. May be empty if the vote was retracted.
   */
-final case class PollAnswer(pollId: String, user: User, optionIds: List[Int] = List.empty)
+final case class PollAnswer(
+  pollId: String,
+  voterChat: Option[Chat] = Option.empty,
+  user: Option[User] = Option.empty,
+  optionIds: List[Int] = List.empty
+)

telegramium-core/src/main/scala/telegramium/bots/Story.scala

@@ -0,0 +1,5 @@
+package telegramium.bots
+
+/** This object represents a message about a forwarded story in the chat. Currently holds no information.
+  */
+case object Story

telegramium-core/src/main/scala/telegramium/bots/client/Methods.scala

@@ -2281,6 +2281,19 @@ trait Methods {
     MethodReq[Boolean]("promoteChatMember", req.asJson)
   }
 
+  /** Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in
+    * the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True
+    * on success.
+    *
+    * @param chatId
+    *   Unique identifier for the target chat or username of the target supergroup (in the format
+    *   @supergroupusername)
+    */
+  def unpinAllGeneralForumTopicMessages(chatId: ChatId): Method[Boolean] = {
+    val req = UnpinAllGeneralForumTopicMessagesReq(chatId)
+    MethodReq[Boolean]("unpinAllGeneralForumTopicMessages", req.asJson)
+  }
+
   /** Use this method to edit captions of messages. On success, if the edited message is not an inline message, the
     * edited Message is returned, otherwise True is returned.
     *

telegramium-core/src/main/scala/telegramium/bots/client/UnpinAllGeneralForumTopicMessagesReq.scala

@@ -0,0 +1,9 @@
+package telegramium.bots.client
+
+import telegramium.bots.ChatId
+
+/** @param chatId
+  *   Unique identifier for the target chat or username of the target supergroup (in the format
+  *   @supergroupusername)
+  */
+final case class UnpinAllGeneralForumTopicMessagesReq(chatId: ChatId)

telegramium-core/src/main/scala/telegramium/bots/client/package.scala

@@ -2407,6 +2407,25 @@ object CirceImplicits {
       }
     }
 
+  implicit lazy val unpinallgeneralforumtopicmessagesreqEncoder: Encoder[UnpinAllGeneralForumTopicMessagesReq] =
+    (x: UnpinAllGeneralForumTopicMessagesReq) => {
+      Json.fromFields(
+        List(
+          "chat_id" -> x.chatId.asJson,
+          "method"  -> "unpinAllGeneralForumTopicMessages".asJson
+        ).filter(!_._2.isNull)
+      )
+    }
+
+  implicit lazy val unpinallgeneralforumtopicmessagesreqDecoder: Decoder[UnpinAllGeneralForumTopicMessagesReq] =
+    Decoder.instance { h =>
+      for {
+        _chatId <- h.get[ChatId]("chat_id")
+      } yield {
+        UnpinAllGeneralForumTopicMessagesReq(chatId = _chatId)
+      }
+    }
+
   implicit lazy val editmessagecaptionreqEncoder: Encoder[EditMessageCaptionReq] =
     (x: EditMessageCaptionReq) => {
       Json.fromFields(

telegramium-core/src/main/scala/telegramium/bots/package.scala

@@ -2816,6 +2816,7 @@ object CirceImplicits {
           "photo"                                   -> x.photo.asJson,
           "active_usernames"                        -> x.activeUsernames.asJson,
           "emoji_status_custom_emoji_id"            -> x.emojiStatusCustomEmojiId.asJson,
+          "emoji_status_expiration_date"            -> x.emojiStatusExpirationDate.asJson,
           "bio"                                     -> x.bio.asJson,
           "has_private_forwards"                    -> x.hasPrivateForwards.asJson,
           "has_restricted_voice_and_video_messages" -> x.hasRestrictedVoiceAndVideoMessages.asJson,
@@ -2851,6 +2852,7 @@ object CirceImplicits {
         _photo                              <- h.get[Option[ChatPhoto]]("photo")
         _activeUsernames                    <- h.getOrElse[List[String]]("active_usernames")(List.empty)
         _emojiStatusCustomEmojiId           <- h.get[Option[String]]("emoji_status_custom_emoji_id")
+        _emojiStatusExpirationDate          <- h.get[Option[Int]]("emoji_status_expiration_date")
         _bio                                <- h.get[Option[String]]("bio")
         _hasPrivateForwards                 <- h.get[Option[Boolean]]("has_private_forwards")
         _hasRestrictedVoiceAndVideoMessages <- h.get[Option[Boolean]]("has_restricted_voice_and_video_messages")
@@ -2881,6 +2883,7 @@ object CirceImplicits {
           photo = _photo,
           activeUsernames = _activeUsernames,
           emojiStatusCustomEmojiId = _emojiStatusCustomEmojiId,
+          emojiStatusExpirationDate = _emojiStatusExpirationDate,
           bio = _bio,
           hasPrivateForwards = _hasPrivateForwards,
           hasRestrictedVoiceAndVideoMessages = _hasRestrictedVoiceAndVideoMessages,
@@ -3538,6 +3541,7 @@ object CirceImplicits {
       Json.fromFields(
         List(
           "poll_id"    -> x.pollId.asJson,
+          "voter_chat" -> x.voterChat.asJson,
           "user"       -> x.user.asJson,
           "option_ids" -> x.optionIds.asJson
         ).filter(!_._2.isNull)
@@ -3548,10 +3552,11 @@ object CirceImplicits {
     Decoder.instance { h =>
       for {
         _pollId    <- h.get[String]("poll_id")
-        _user      <- h.get[User]("user")
+        _voterChat <- h.get[Option[Chat]]("voter_chat")
+        _user      <- h.get[Option[User]]("user")
         _optionIds <- h.getOrElse[List[Int]]("option_ids")(List.empty)
       } yield {
-        PollAnswer(pollId = _pollId, user = _user, optionIds = _optionIds)
+        PollAnswer(pollId = _pollId, voterChat = _voterChat, user = _user, optionIds = _optionIds)
       }
     }
 
@@ -3895,6 +3900,9 @@ object CirceImplicits {
       }
     }
 
+  implicit lazy val storyEncoder: Encoder[Story.type] = (_: Story.type) => ().asJson
+  implicit lazy val storyDecoder: Decoder[Story.type] = (_: HCursor) => Right(Story)
+
   implicit lazy val passportdataEncoder: Encoder[PassportData] =
     (x: PassportData) => {
       Json.fromFields(
@@ -4573,6 +4581,7 @@ object CirceImplicits {
           "document"                          -> x.document.asJson,
           "photo"                             -> x.photo.asJson,
           "sticker"                           -> x.sticker.asJson,
+          "story"                             -> x.story.asJson,
           "video"                             -> x.video.asJson,
           "video_note"                        -> x.videoNote.asJson,
           "voice"                             -> x.voice.asJson,
@@ -4651,6 +4660,7 @@ object CirceImplicits {
         _document              <- h.get[Option[Document]]("document")
         _photo                 <- h.getOrElse[List[PhotoSize]]("photo")(List.empty)
         _sticker               <- h.get[Option[Sticker]]("sticker")
+        _story                 <- h.get[Option[Story.type]]("story")
         _video                 <- h.get[Option[Video]]("video")
         _videoNote             <- h.get[Option[VideoNote]]("video_note")
         _voice                 <- h.get[Option[Voice]]("voice")
@@ -4726,6 +4736,7 @@ object CirceImplicits {
           document = _document,
           photo = _photo,
           sticker = _sticker,
+          story = _story,
           video = _video,
           videoNote = _videoNote,
           voice = _voice,

telegramium-high/src/test/scala/telegramium/bots/high/LongPollBotISpec.scala

@@ -166,7 +166,7 @@ class LongPollBotISpec
       mockServerClient
         .when(sendMessageRequest("onPollAnswer"))
         .respond(sendMessageResponse)
-      bot.onUpdate(testUpdate.copy(pollAnswer = PollAnswer("0", testUser).some)).unsafeRunSync()
+      bot.onUpdate(testUpdate.copy(pollAnswer = PollAnswer("0", user = testUser.some).some)).unsafeRunSync()
     }
 
     "The bot's chat member status was updated in a chat" in {

telegramium-high/src/test/scala/telegramium/bots/high/WebhookBotISpec.scala

@@ -297,7 +297,7 @@ class WebhookBotISpec
       mockServerClient
         .when(sendMessageRequest("onPollAnswer"))
         .respond(sendMessageResponse)
-      verifyResult(testUpdate.copy(pollAnswer = PollAnswer("0", testUser).some), "onPollAnswerReply")
+      verifyResult(testUpdate.copy(pollAnswer = PollAnswer("0", user = testUser.some).some), "onPollAnswerReply")
     }
 
     "The bot's chat member status was updated in a chat" in {