Telegram Bot API August 14, 2024 updates (v7.9)

Author: johnspade

README.md

@@ -1,6 +1,6 @@
 # F[Tg] - Telegramium
 
-[![Telegram](https://img.shields.io/badge/Telegram%20Bot%20API-7.8%20(July%2031%2C%202024)-blue)](https://core.telegram.org/bots/api#recent-changes)
+[![Telegram](https://img.shields.io/badge/Telegram%20Bot%20API-7.9%20(August%2014%2C%202024)-blue)](https://core.telegram.org/bots/api#recent-changes)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.apimorphism/telegramium-core_3/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.apimorphism/telegramium-core_3)
 
 

build.sbt

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

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

@@ -90,8 +90,10 @@ final case class ChatMemberLeft(user: User) extends ChatMember
   *
   * @param user
   *   Information about the user
+  * @param untilDate
+  *   Optional. Date when the user's subscription will expire; Unix time
   */
-final case class ChatMemberMember(user: User) extends ChatMember
+final case class ChatMemberMember(user: User, untilDate: Option[Int] = Option.empty) extends ChatMember
 
 /** Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
   *

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

@@ -13,13 +13,13 @@ sealed trait MaybeInaccessibleMessage {}
   * @param messageThreadId
   *   Optional. Unique identifier of a message thread to which the message belongs; for supergroups only
   * @param from
-  *   Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field
-  *   contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
+  *   Optional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the
+  *   message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats
   * @param senderChat
-  *   Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the
-  *   supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically
-  *   forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in
-  *   non-channel chats, if the message was sent on behalf of a chat.
+  *   Optional. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages
+  *   sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's
+  *   discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains
+  *   a fake sender user in non-channel chats.
   * @param senderBoostCount
   *   Optional. If the sender of the message boosted the chat, the number of boosts added by the user
   * @param senderBusinessBot

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

@@ -2,6 +2,9 @@ package telegramium.bots
 
 sealed trait ReactionType {}
 
+/** The reaction is paid. */
+case object ReactionTypePaid extends ReactionType
+
 /** The reaction is based on an emoji.
   *
   * @param emoji

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

@@ -14,9 +14,14 @@ case object TransactionPartnerTelegramAds extends TransactionPartner
   *   Information about the user
   * @param invoicePayload
   *   Optional. Bot-specified invoice payload
+  * @param paidMedia
+  *   Optional. Information about the paid media bought by the user
   */
-final case class TransactionPartnerUser(user: User, invoicePayload: Option[String] = Option.empty)
-    extends TransactionPartner
+final case class TransactionPartnerUser(
+  user: User,
+  invoicePayload: Option[String] = Option.empty,
+  paidMedia: List[iozhik.OpenEnum[PaidMedia]] = List.empty
+) extends TransactionPartner
 
 /** Describes a withdrawal transaction with Fragment.
   *

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

@@ -0,0 +1,22 @@
+package telegramium.bots.client
+
+import telegramium.bots.ChatId
+
+/** @param chatId
+  *   Unique identifier for the target channel chat or username of the target channel (in the format
+  *   @channelusername)
+  * @param subscriptionPeriod
+  *   The number of seconds the subscription will be active for before the next payment. Currently, it must always be
+  *   2592000 (30 days).
+  * @param subscriptionPrice
+  *   The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a
+  *   member of the chat; 1-2500
+  * @param name
+  *   Invite link name; 0-32 characters
+  */
+final case class CreateChatSubscriptionInviteLinkReq(
+  chatId: ChatId,
+  subscriptionPeriod: Int,
+  subscriptionPrice: Int,
+  name: Option[String] = Option.empty
+)

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

@@ -0,0 +1,16 @@
+package telegramium.bots.client
+
+import telegramium.bots.ChatId
+
+/** @param chatId
+  *   Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+  * @param inviteLink
+  *   The invite link to edit
+  * @param name
+  *   Invite link name; 0-32 characters
+  */
+final case class EditChatSubscriptionInviteLinkReq(
+  chatId: ChatId,
+  inviteLink: String,
+  name: Option[String] = Option.empty
+)

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

@@ -411,6 +411,32 @@ trait Methods {
     MethodReq[ChatInviteLink]("createChatInviteLink", req.asJson)
   }
 
+  /** Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users
+    * administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the
+    * method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.
+    *
+    * @param chatId
+    *   Unique identifier for the target channel chat or username of the target channel (in the format
+    *   @channelusername)
+    * @param subscriptionPeriod
+    *   The number of seconds the subscription will be active for before the next payment. Currently, it must always be
+    *   2592000 (30 days).
+    * @param subscriptionPrice
+    *   The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a
+    *   member of the chat; 1-2500
+    * @param name
+    *   Invite link name; 0-32 characters
+    */
+  def createChatSubscriptionInviteLink(
+    chatId: ChatId,
+    subscriptionPeriod: Int,
+    subscriptionPrice: Int,
+    name: Option[String] = Option.empty
+  ): Method[ChatInviteLink] = {
+    val req = CreateChatSubscriptionInviteLinkReq(chatId, subscriptionPeriod, subscriptionPrice, name)
+    MethodReq[ChatInviteLink]("createChatSubscriptionInviteLink", req.asJson)
+  }
+
   /** Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for
     * this to work and must have the can_manage_topics administrator rights. Returns information about the created topic
     * as a ForumTopic object.
@@ -734,9 +760,28 @@ trait Methods {
     MethodReq[ChatInviteLink]("editChatInviteLink", req.asJson)
   }
 
+  /** Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users
+    * administrator rights. Returns the edited invite link as a ChatInviteLink object.
+    *
+    * @param chatId
+    *   Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+    * @param inviteLink
+    *   The invite link to edit
+    * @param name
+    *   Invite link name; 0-32 characters
+    */
+  def editChatSubscriptionInviteLink(
+    chatId: ChatId,
+    inviteLink: String,
+    name: Option[String] = Option.empty
+  ): Method[ChatInviteLink] = {
+    val req = EditChatSubscriptionInviteLinkReq(chatId, inviteLink, name)
+    MethodReq[ChatInviteLink]("editChatSubscriptionInviteLink", req.asJson)
+  }
+
   /** Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in
-    * the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the
-    * topic. Returns True on success.
+    * the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of
+    * the topic. Returns True on success.
     *
     * @param chatId
     *   Unique identifier for the target chat or username of the target supergroup (in the format
@@ -761,8 +806,8 @@ trait Methods {
   }
 
   /** Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an
-    * administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on
-    * success.
+    * administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True
+    * on success.
     *
     * @param chatId
     *   Unique identifier for the target chat or username of the target supergroup (in the format
@@ -2361,12 +2406,16 @@ trait Methods {
     MethodReq[Message]("sendMessage", req.asJson)
   }
 
-  /** Use this method to send paid media to channel chats. On success, the sent Message is returned.
+  /** Use this method to send paid media. On success, the sent Message is returned.
     *
     * @param chatId
-    *   Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+    *   Unique identifier for the target chat or username of the target channel (in the format @channelusername).
+    *   If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance.
+    *   Otherwise, they will be credited to the bot's balance.
     * @param starCount
     *   The number of Telegram Stars that must be paid to buy access to the media
+    * @param businessConnectionId
+    *   Unique identifier of the business connection on behalf of which the message will be sent
     * @param media
     *   A JSON-serialized array describing the media to be sent; up to 10 items
     * @param caption
@@ -2391,6 +2440,7 @@ trait Methods {
   def sendPaidMedia(
     chatId: ChatId,
     starCount: Int,
+    businessConnectionId: Option[String] = Option.empty,
     media: List[InputPaidMedia] = List.empty,
     caption: Option[String] = Option.empty,
     parseMode: Option[ParseMode] = Option.empty,
@@ -2404,6 +2454,7 @@ trait Methods {
     val req = SendPaidMediaReq(
       chatId,
       starCount,
+      businessConnectionId,
       media,
       caption,
       parseMode,
@@ -3128,7 +3179,7 @@ trait Methods {
 
   /** Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically
     * forwarded messages from a channel to its discussion group have the same available reactions as messages in the
-    * channel. Returns True on success.
+    * channel. Bots can't use paid reactions. Returns True on success.
     *
     * @param chatId
     *   Unique identifier for the target chat or username of the target channel (in the format @channelusername)
@@ -3138,7 +3189,7 @@ trait Methods {
     * @param reaction
     *   A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up
     *   to one reaction per message. A custom emoji reaction can be used if it is either already present on the message
-    *   or explicitly allowed by chat administrators.
+    *   or explicitly allowed by chat administrators. Paid reactions can't be used by bots.
     * @param isBig
     *   Pass True to set the reaction with a big animation
     */

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

@@ -8,9 +8,13 @@ import telegramium.bots.ReplyParameters
 import telegramium.bots.KeyboardMarkup
 
 /** @param chatId
-  *   Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+  *   Unique identifier for the target chat or username of the target channel (in the format @channelusername). If
+  *   the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance.
+  *   Otherwise, they will be credited to the bot's balance.
   * @param starCount
   *   The number of Telegram Stars that must be paid to buy access to the media
+  * @param businessConnectionId
+  *   Unique identifier of the business connection on behalf of which the message will be sent
   * @param media
   *   A JSON-serialized array describing the media to be sent; up to 10 items
   * @param caption
@@ -35,6 +39,7 @@ import telegramium.bots.KeyboardMarkup
 final case class SendPaidMediaReq(
   chatId: ChatId,
   starCount: Int,
+  businessConnectionId: Option[String] = Option.empty,
   media: List[InputPaidMedia] = List.empty,
   caption: Option[String] = Option.empty,
   parseMode: Option[ParseMode] = Option.empty,

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

@@ -11,7 +11,7 @@ import telegramium.bots.ReactionType
   * @param reaction
   *   A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up
   *   to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or
-  *   explicitly allowed by chat administrators.
+  *   explicitly allowed by chat administrators. Paid reactions can't be used by bots.
   * @param isBig
   *   Pass True to set the reaction with a big animation
   */

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

@@ -4,7 +4,6 @@ object CirceImplicits {
 
   import io.circe.syntax._
   import io.circe.{Encoder, Decoder, Json}
-  import iozhik._
   import telegramium.bots.InputSticker
   import telegramium.bots.CirceImplicits._
   import telegramium.bots.InlineQueryResult
@@ -238,6 +237,19 @@ object CirceImplicits {
       )
     }
 
+  implicit lazy val createchatsubscriptioninvitelinkreqEncoder: Encoder[CreateChatSubscriptionInviteLinkReq] =
+    (x: CreateChatSubscriptionInviteLinkReq) => {
+      Json.fromFields(
+        List(
+          "chat_id"             -> x.chatId.asJson,
+          "name"                -> x.name.asJson,
+          "subscription_period" -> x.subscriptionPeriod.asJson,
+          "subscription_price"  -> x.subscriptionPrice.asJson,
+          "method"              -> "createChatSubscriptionInviteLink".asJson
+        ).filter(!_._2.isNull)
+      )
+    }
+
   implicit lazy val createforumtopicreqEncoder: Encoder[CreateForumTopicReq] =
     (x: CreateForumTopicReq) => {
       Json.fromFields(
@@ -415,6 +427,18 @@ object CirceImplicits {
       )
     }
 
+  implicit lazy val editchatsubscriptioninvitelinkreqEncoder: Encoder[EditChatSubscriptionInviteLinkReq] =
+    (x: EditChatSubscriptionInviteLinkReq) => {
+      Json.fromFields(
+        List(
+          "chat_id"     -> x.chatId.asJson,
+          "invite_link" -> x.inviteLink.asJson,
+          "name"        -> x.name.asJson,
+          "method"      -> "editChatSubscriptionInviteLink".asJson
+        ).filter(!_._2.isNull)
+      )
+    }
+
   implicit lazy val editforumtopicreqEncoder: Encoder[EditForumTopicReq] =
     (x: EditForumTopicReq) => {
       Json.fromFields(
@@ -1151,6 +1175,7 @@ object CirceImplicits {
     (x: SendPaidMediaReq) => {
       Json.fromFields(
         List(
+          "business_connection_id"   -> x.businessConnectionId.asJson,
           "chat_id"                  -> x.chatId.asJson,
           "star_count"               -> x.starCount.asJson,
           "media"                    -> x.media.asJson,