[api] Support v6.0 (#211)

 https://core.telegram.org/bots/api#april-16-2022

  - [x] Added support for Web Apps, see the detailed manual here. (blog announcement)
  - [x] Added the class WebAppInfo and the fields web_app to the classes KeyboardButton and InlineKeyboardButton.
  - [x] Added the class SentWebAppMessage and the method answerWebAppQuery for sending an answer to a Web App query, which originated from an inline button of the 'web_app' type.
  - [x] Added the class WebAppData and the field web_app_data to the class Message.
  - [x] Added the class MenuButton and the methods setChatMenuButton and getChatMenuButton for managing the behavior of the bot's menu button in private chats.
  - [x] Added the class ChatAdministratorRights and the methods setMyDefaultAdministratorRights and getMyDefaultAdministratorRights for managing the bot's default administrator rights.
  - [x] Added support for t.me links that can be used to add the bot to groups and channels as an administrator.
  - [x] Added the field last_synchronization_error_date to the class WebhookInfo.
  - [x] Renamed the field can_manage_voice_chats to can_manage_video_chats in the class ChatMemberAdministrator. The old field will remain temporarily available.
  - [x] Renamed the parameter can_manage_voice_chats to can_manage_video_chats in the method promoteChatMember. The old parameter will remain temporarily available.
  - [x] Renamed the fields voice_chat_scheduled, voice_chat_started, voice_chat_ended, and voice_chat_participants_invited to video_chat_scheduled, video_chat_started, video_chat_ended, and video_chat_participants_invited in the class Message. The old fields will remain temporarily available.

Author: ex0ns

core/src/com/bot4s/telegram/api/RequestHandler.scala

@@ -7,6 +7,7 @@ import cats.syntax.flatMap._
 import cats.syntax.functor._
 import cats.syntax.monadError._
 import com.bot4s.telegram.methods._
+import com.bot4s.telegram.models.MenuButton.menuButtonDecoder
 import io.circe.{ Decoder, Encoder }
 import com.typesafe.scalalogging.StrictLogging
 
@@ -46,6 +47,7 @@ abstract class RequestHandler[F[_]](implicit monadError: MonadError[F, Throwable
       // Pure JSON requests
       case s: ApproveChatJoinRequest          => sendRequest[R, ApproveChatJoinRequest](s)
       case s: AnswerCallbackQuery             => sendRequest[R, AnswerCallbackQuery](s)
+      case s: AnswerWebAppQuery               => sendRequest[R, AnswerWebAppQuery](s)
       case s: AnswerInlineQuery               => sendRequest[R, AnswerInlineQuery](s)
       case s: AnswerPreCheckoutQuery          => sendRequest[R, AnswerPreCheckoutQuery](s)
       case s: AnswerShippingQuery             => sendRequest[R, AnswerShippingQuery](s)
@@ -68,6 +70,7 @@ abstract class RequestHandler[F[_]](implicit monadError: MonadError[F, Throwable
       case s: GetChatMember                   => sendRequest[R, GetChatMember](s)
       case s: GetChatMemberCount              => sendRequest[R, GetChatMemberCount](s)
       case s: GetChatMembersCount             => sendRequest[R, GetChatMembersCount](s)
+      case s: GetChatMenuButton               => sendRequest[R, GetChatMenuButton](s)
       case s: GetFile                         => sendRequest[R, GetFile](s)
       case s: GetGameHighScores               => sendRequest[R, GetGameHighScores](s)
       case s: GetMe.type                      => sendRequest[R, GetMe.type](s)
@@ -94,6 +97,7 @@ abstract class RequestHandler[F[_]](implicit monadError: MonadError[F, Throwable
       case s: SendPoll                        => sendRequest[R, SendPoll](s)
       case s: SendVenue                       => sendRequest[R, SendVenue](s)
       case s: SetChatDescription              => sendRequest[R, SetChatDescription](s)
+      case s: SetChatMenuButton               => sendRequest[R, SetChatMenuButton](s)
       case s: SetChatAdministratorCustomTitle => sendRequest[R, SetChatAdministratorCustomTitle](s)
       case s: SetChatPermissions              => sendRequest[R, SetChatPermissions](s)
       case s: SetChatStickerSet               => sendRequest[R, SetChatStickerSet](s)

core/src/com/bot4s/telegram/marshalling/CirceDecoders.scala

@@ -16,10 +16,9 @@ import com.bot4s.telegram.models.BotCommandScope.BotCommandScope
 import com.bot4s.telegram.models.MessageEntityType.MessageEntityType
 import UpdateType.UpdateType
 import com.bot4s.telegram.models._
-import io.circe.Decoder
+import io.circe.{ Decoder, HCursor }
 import io.circe.generic.semiauto._
 import com.typesafe.scalalogging.StrictLogging
-import io.circe.HCursor
 
 /**
  * Circe marshalling borrowed/inspired from [[https://github.com/nikdon/telepooz]]
@@ -71,6 +70,11 @@ trait CirceDecoders extends StrictLogging {
   implicit val botCommandDecoder: Decoder[BotCommand] = deriveDecoder[BotCommand]
 
   implicit val chatLocationDecoder: Decoder[ChatLocation] = deriveDecoder[ChatLocation]
+  // for v6.0 support
+  implicit val webAppInfoDecoder: Decoder[WebAppInfo]                   = deriveDecoder[WebAppInfo]
+  implicit val webAppDataDecoder: Decoder[WebAppData]                   = deriveDecoder[WebAppData]
+  implicit val chatAdminRightsDecoder: Decoder[ChatAdministratorRights] = deriveDecoder[ChatAdministratorRights]
+  implicit val sentWebAppMessageDecoder: Decoder[SentWebAppMessage]     = deriveDecoder[SentWebAppMessage]
   // for v5.1 support
   implicit val chatInviteLinkDecoder: Decoder[ChatInviteLink]       = deriveDecoder[ChatInviteLink]
   implicit val chatMemberUpdatedDecoder: Decoder[ChatMemberUpdated] = deriveDecoder[ChatMemberUpdated]
@@ -82,6 +86,8 @@ trait CirceDecoders extends StrictLogging {
   implicit val chatDecoder: Decoder[Chat]           = deriveDecoder[Chat]
   implicit val chatPhotoDecoder: Decoder[ChatPhoto] = deriveDecoder[ChatPhoto]
 
+  implicit val KeyboardButtonPollTypeDecoder: Decoder[KeyboardButtonPollType] = deriveDecoder[KeyboardButtonPollType]
+
   implicit val contactDecoder: Decoder[Contact]                           = deriveDecoder[Contact]
   implicit val documentDecoder: Decoder[Document]                         = deriveDecoder[Document]
   implicit val fileDecoder: Decoder[File]                                 = deriveDecoder[File]
@@ -120,6 +126,11 @@ trait CirceDecoders extends StrictLogging {
   implicit val videoDecoder: Decoder[Video]                         = deriveDecoder[Video]
   implicit val videoNoteDecoder: Decoder[VideoNote]                 = deriveDecoder[VideoNote]
   implicit val voiceDecoder: Decoder[Voice]                         = deriveDecoder[Voice]
+  implicit val videoChatEndedDecoder: Decoder[VideoChatEnded]       = deriveDecoder[VideoChatEnded]
+  implicit val videoChatParticipantsInvitedDecoder: Decoder[VideoChatParticipantsInvited] =
+    deriveDecoder[VideoChatParticipantsInvited]
+  implicit val videoChatScheduledDecoder: Decoder[VideoChatScheduled]  = deriveDecoder[VideoChatScheduled]
+  implicit val videoChatStartedDecoder: Decoder[VideoChatStarted.type] = deriveDecoder[VideoChatStarted.type]
 
   implicit val gameHighScoreDecoder: Decoder[GameHighScore] = deriveDecoder[GameHighScore]
   implicit val animationDecoder: Decoder[Animation]         = deriveDecoder[Animation]
@@ -177,6 +188,7 @@ trait CirceDecoders extends StrictLogging {
     val r: Decoder[Either[A, B]] = decB.map(Right.apply)
     l or r
   }
+
 }
 
 object CirceDecoders extends CirceDecoders

core/src/com/bot4s/telegram/marshalling/CirceEncoders.scala

@@ -214,6 +214,23 @@ trait CirceEncoders {
 
   implicit val answerInlineQueryEncoder: Encoder[AnswerInlineQuery] = deriveConfiguredEncoder[AnswerInlineQuery]
 
+  // MenuButton
+
+  implicit val menuButtonDefaultEncoder: Encoder[MenuButtonDefault] =
+    deriveConfiguredEncoder[MenuButtonDefault]
+
+  implicit val menuButtonWebAppEncoder: Encoder[MenuButtonWebApp] =
+    deriveConfiguredEncoder[MenuButtonWebApp]
+
+  implicit val menuButtonCommandsEncoder: Encoder[MenuButtonCommands] =
+    deriveConfiguredEncoder[MenuButtonCommands]
+
+  implicit val menuButtonEncoder: Encoder[MenuButton] = Encoder.instance {
+    case q: MenuButtonDefault  => q.asJson
+    case q: MenuButtonWebApp   => q.asJson
+    case q: MenuButtonCommands => q.asJson
+  }
+
   // Methods
   implicit val getMeEncoder: Encoder[GetMe.type]                   = Encoder.instance(_ => io.circe.Json.Null)
   implicit val deleteWebhookEncoder: Encoder[DeleteWebhook.type]   = Encoder.instance(_ => io.circe.Json.Null)
@@ -229,6 +246,14 @@ trait CirceEncoders {
   implicit val getUpdatesEncoder: Encoder[GetUpdates]         = deriveConfiguredEncoder[GetUpdates]
 
   implicit val chatLocationEncoder: Encoder[ChatLocation] = deriveConfiguredEncoder[ChatLocation]
+  // for v6.0 support
+  implicit val webAppInfoEncoder: Encoder[WebAppInfo] = deriveConfiguredEncoder[WebAppInfo]
+  implicit val webAppDataEncoder: Encoder[WebAppData] = deriveConfiguredEncoder[WebAppData]
+  implicit val chatAdminRightsEncoder: Encoder[ChatAdministratorRights] =
+    deriveConfiguredEncoder[ChatAdministratorRights]
+  implicit val answerWebAppQueryEncoder: Encoder[AnswerWebAppQuery] = deriveConfiguredEncoder[AnswerWebAppQuery]
+  implicit val sentWebAppMessageEncoder: Encoder[SentWebAppMessage] = deriveConfiguredEncoder[SentWebAppMessage]
+
   // for v5.1 support
   implicit val chatInviteLinkEncoder: Encoder[ChatInviteLink]       = deriveConfiguredEncoder[ChatInviteLink]
   implicit val chatMemberUpdatedEncoder: Encoder[ChatMemberUpdated] = deriveConfiguredEncoder[ChatMemberUpdated]
@@ -289,6 +314,7 @@ trait CirceEncoders {
   implicit val getChatMemberCountEncoder: Encoder[GetChatMemberCount]   = deriveConfiguredEncoder[GetChatMemberCount]
   implicit val getChatMembersCountEncoder: Encoder[GetChatMembersCount] = deriveConfiguredEncoder[GetChatMembersCount]
   implicit val getChatMemberEncoder: Encoder[GetChatMember]             = deriveConfiguredEncoder[GetChatMember]
+  implicit val getChatMenuButtonEncoder: Encoder[GetChatMenuButton]     = deriveConfiguredEncoder[GetChatMenuButton]
   implicit val answerCallbackQueryEncoder: Encoder[AnswerCallbackQuery] = deriveConfiguredEncoder[AnswerCallbackQuery]
 
   implicit val editMessageTextEncoder: Encoder[EditMessageText]       = deriveConfiguredEncoder[EditMessageText]
@@ -327,7 +353,8 @@ trait CirceEncoders {
 
   implicit val setChatStickerSetEncoder: Encoder[SetChatStickerSet] = deriveConfiguredEncoder[SetChatStickerSet]
 
-  implicit val setChatTitleEncoder: Encoder[SetChatTitle] = deriveConfiguredEncoder[SetChatTitle]
+  implicit val setChatTitleEncoder: Encoder[SetChatTitle]       = deriveConfiguredEncoder[SetChatTitle]
+  implicit val setChatButtonEncoder: Encoder[SetChatMenuButton] = deriveConfiguredEncoder[SetChatMenuButton]
 
   implicit val setStickerPositionInSetEncoder: Encoder[SetStickerPositionInSet] =
     deriveConfiguredEncoder[SetStickerPositionInSet]

core/src/com/bot4s/telegram/methods/AnswerWebAppQuery.scala

@@ -0,0 +1,14 @@
+package com.bot4s.telegram.methods
+
+import com.bot4s.telegram.models.{ InlineQueryResult, SentWebAppMessage }
+
+/**
+ * Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
+ *
+ * @param webAppQueryId   Unique identifier for the query to be answered
+ * @param result           	A JSON-serialized object describing the message to be sent
+ */
+case class AnswerWebAppQuery(
+  webAppQueryId: String,
+  result: Option[InlineQueryResult] = None
+) extends JsonRequest[SentWebAppMessage]

core/src/com/bot4s/telegram/methods/GetChatMenuButton.scala

@@ -0,0 +1,13 @@
+package com.bot4s.telegram.methods
+
+import com.bot4s.telegram.models.{ ChatId, MenuButton }
+
+/**
+ * Use this method to get the current value of the bot's menu button in a private chat, or the default menu button.
+ * Returns MenuButton on success.
+ *
+ * @param chatId      Integer or String Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+ */
+case class GetChatMenuButton(
+  chatId: ChatId
+) extends JsonRequest[MenuButton]

core/src/com/bot4s/telegram/methods/GetMyDefaultAdministratorRights.scala

@@ -0,0 +1,13 @@
+package com.bot4s.telegram.methods
+
+import com.bot4s.telegram.models.ChatAdministratorRights
+
+/**
+ * Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
+ *
+ * @param forChannels Optional Boolean. Pass True to change the default administrator rights of the bot in channels.
+ *                    Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
+ */
+case class GetMyDefaultAdministratorRights(
+  forChannels: Option[Boolean] = None
+) extends JsonRequest[ChatAdministratorRights]

core/src/com/bot4s/telegram/methods/PromoteChatMember.scala

@@ -11,11 +11,16 @@ import com.bot4s.telegram.models.ChatId
  * @param chatId              Integer or String Unique identifier for the target chat or username of the target channel
  *                            (in the format @channelusername)
  * @param userId              Long Unique identifier of the target user
+ * @param isAnonymous         Boolean Optional Pass True, if the administrator's presence in the chat is hidden
+ * @param canManageChat       Boolean Optional Pass True, if the administrator can access the chat event log,
+ *                            chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode.
+ *                            Implied by any other administrator privilege
  * @param canChangeInfo       Boolean Optional Pass True, if the administrator can change chat title, photo and other settings
  * @param canPostMessages     Boolean Optional Pass True, if the administrator can create channel posts, channels only
  * @param canEditMessages     Boolean Optional Pass True, if the administrator can edit messages of other users, channels only
  * @param canDeleteMessages   Boolean Optional Pass True, if the administrator can delete messages of other users
  * @param canInviteUsers      Boolean Optional Pass True, if the administrator can invite new users to the chat
+ * @param canManageVideoChats Boolean Optional Pass True, if the administrator can manage video chats
  * @param canRestrictMembers  Boolean Optional Pass True, if the administrator can restrict, ban or unban chat members
  * @param canPinMessages      Boolean Optional Pass True, if the administrator can pin messages, supergroups only
  * @param canPromoteMembers   Boolean Optional Pass True, if the administrator can add new administrators with a subset
@@ -25,11 +30,14 @@ import com.bot4s.telegram.models.ChatId
 case class PromoteChatMember(
   chatId: ChatId,
   userId: Long,
+  isAnonymous: Option[Boolean] = None,
+  canManageChat: Option[Boolean] = None,
   canChangeInfo: Option[Boolean] = None,
   canPostMessages: Option[Boolean] = None,
   canEditMessages: Option[Boolean] = None,
   canDeleteMessages: Option[Boolean] = None,
   canInviteUsers: Option[Boolean] = None,
+  canManageVideoChats: Option[Boolean] = None,
   canRestrictMembers: Option[Boolean] = None,
   canPinMessages: Option[Boolean] = None,
   canPromoteMembers: Option[Boolean] = None

core/src/com/bot4s/telegram/methods/SetChatMenuButton.scala

@@ -0,0 +1,14 @@
+package com.bot4s.telegram.methods
+
+import com.bot4s.telegram.models.{ ChatId, MenuButton, MenuButtonDefault }
+
+/**
+ * Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
+ *
+ * @param chatId 	      Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+ * @param menuButton 	  A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault
+ */
+case class SetChatMenuButton(
+  chatId: ChatId,
+  menuButton: Option[MenuButton] = Some(MenuButtonDefault())
+) extends JsonRequest[Boolean]

core/src/com/bot4s/telegram/methods/SetMyDefaultAdministratorRights.scala

@@ -0,0 +1,18 @@
+package com.bot4s.telegram.methods
+
+import com.bot4s.telegram.models.ChatAdministratorRights
+
+/**
+ *  Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels.
+ *  These rights will be suggested to users, but they are are free to modify the list before adding the bot.
+ *  Returns True on success.
+ *
+ * @param rights      Optional ChatAdministratorRights. A JSON-serialized object describing new default administrator rights.
+ *                    If not specified, the default administrator rights will be cleared.
+ * @param forChannels Optional Boolean. Pass True to change the default administrator rights of the bot in channels.
+ *                    Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
+ */
+case class SetMyDefaultAdministratorRights(
+  rights: Option[ChatAdministratorRights] = None,
+  forChannels: Option[Boolean] = None
+) extends JsonRequest[Boolean]

core/src/com/bot4s/telegram/models/ChatAdministratorRights.scala

@@ -0,0 +1,36 @@
+package com.bot4s.telegram.models
+
+/**
+ * Represents the rights of an administrator in a chat.
+ *
+ * @param isAnonymous         Boolean True, if the user's presence in the chat is hidden
+ * @param canManageChat       Boolean True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege
+ * @param canDeleteMessages   Boolean True, if the administrator can delete messages of other users
+ * @param canManageVideoChats Boolean True, if the administrator can manage video chats
+ * @param canRestrictMembers  Boolean True, if the administrator can restrict, ban or unban chat members
+ * @param canPromoteMembers   Boolean True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)
+ * @param canChangeInfo       Boolean True, if the user is allowed to change the chat title, photo and other settings
+ * @param canInviteUsers      Boolean True, if the user is allowed to invite new users to the chat
+ * @param canPostMessages     Boolean Optional. True, if the administrator can post in the channel; channels only
+ * @param canEditMessages     Boolean Optional. True, if the administrator can edit messages of other users and can pin messages; channels only
+ * @param canPinMessages      Boolean Optional. True, if the user is allowed to pin messages; groups and supergroups only
+ * @param from                Performer of the action, which resulted in the change
+ * @param date                Date the change was done in Unix time
+ * @param chat                Chat the user belongs to
+ * @param oldChatMember       Previous information about the chat member
+ * @param newChatMember       New information about the chat member
+ * @param inviteLink          Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.
+ */
+case class ChatAdministratorRights(
+  isAnonymous: Boolean,
+  canManageChat: Boolean,
+  canDeleteMessages: Boolean,
+  canManageVideoChats: Boolean,
+  canRestrictMembers: Boolean,
+  canPromoteMembers: Boolean,
+  canChangeInfo: Boolean,
+  canInviteUsers: Boolean,
+  canPostMessages: Option[Boolean],
+  canEditMessages: Option[Boolean],
+  canPinMessages: Option[Boolean]
+)