@spec add_sticker_to_set(
  user_id :: integer(),
  name :: String.t(),
  sticker :: ExGram.Model.InputSticker.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

Check the documentation of this method on Telegram Bot API

• user_id: User identifier of sticker set owner
• name: Sticker set name
• sticker: A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.

@spec add_sticker_to_set!(
  user_id :: integer(),
  name :: String.t(),
  sticker :: ExGram.Model.InputSticker.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of add_sticker_to_set/4. It will return the response or raise in case of error.

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec answer_callback_query(
  callback_query_id :: String.t(),
  options :: [
    text: String.t(),
    show_alert: boolean(),
    url: String.t(),
    cache_time: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Check the documentation of this method on Telegram Bot API

• callback_query_id: Unique identifier for the query to be answered
• text (optional): Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
• show_alert (optional): If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
• url (optional): URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
• cache_time (optional): The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

@spec answer_callback_query!(
  callback_query_id :: String.t(),
  ops :: [
    text: String.t(),
    show_alert: boolean(),
    url: String.t(),
    cache_time: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_callback_query/2. It will return the response or raise in case of error.

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Check the documentation of this method on Telegram Bot API

@spec answer_inline_query(
  inline_query_id :: String.t(),
  results :: [ExGram.Model.InlineQueryResult.t()],
  options :: [
    cache_time: integer(),
    is_personal: boolean(),
    next_offset: String.t(),
    button: ExGram.Model.InlineQueryResultsButton.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Check the documentation of this method on Telegram Bot API

• inline_query_id: Unique identifier for the answered query
• results: A JSON-serialized array of results for the inline query
• cache_time (optional): The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
• is_personal (optional): Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
• next_offset (optional): Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.
• button (optional): A JSON-serialized object describing a button to be shown above inline query results

@spec answer_inline_query!(
  inline_query_id :: String.t(),
  results :: [ExGram.Model.InlineQueryResult.t()],
  ops :: [
    cache_time: integer(),
    is_personal: boolean(),
    next_offset: String.t(),
    button: ExGram.Model.InlineQueryResultsButton.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_inline_query/3. It will return the response or raise in case of error.

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Check the documentation of this method on Telegram Bot API

@spec answer_pre_checkout_query(
  pre_checkout_query_id :: String.t(),
  ok :: boolean(),
  options :: [
    error_message: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Check the documentation of this method on Telegram Bot API

• pre_checkout_query_id: Unique identifier for the query to be answered
• ok: Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
• error_message (optional): Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

@spec answer_pre_checkout_query!(
  pre_checkout_query_id :: String.t(),
  ok :: boolean(),
  ops :: [
    error_message: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_pre_checkout_query/3. It will return the response or raise in case of error.

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Check the documentation of this method on Telegram Bot API

@spec answer_shipping_query(
  shipping_query_id :: String.t(),
  ok :: boolean(),
  options :: [
    shipping_options: [ExGram.Model.ShippingOption.t()],
    error_message: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Check the documentation of this method on Telegram Bot API

• shipping_query_id: Unique identifier for the query to be answered
• ok: Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
• shipping_options (optional): Required if ok is True. A JSON-serialized array of available shipping options.
• error_message (optional): Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.

@spec answer_shipping_query!(
  shipping_query_id :: String.t(),
  ok :: boolean(),
  ops :: [
    shipping_options: [ExGram.Model.ShippingOption.t()],
    error_message: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_shipping_query/3. It will return the response or raise in case of error.

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Check the documentation of this method on Telegram Bot API

@spec answer_web_app_query(
  web_app_query_id :: String.t(),
  result :: ExGram.Model.InlineQueryResult.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.SentWebAppMessage.t()} | {:error, ExGram.Error.t()}

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.

Check the documentation of this method on Telegram Bot API

• web_app_query_id: Unique identifier for the query to be answered
• result: A JSON-serialized object describing the message to be sent

@spec answer_web_app_query!(
  web_app_query_id :: String.t(),
  result :: ExGram.Model.InlineQueryResult.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.SentWebAppMessage.t()

Unsafe version of answer_web_app_query/3. It will return the response or raise in case of error.

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.

Check the documentation of this method on Telegram Bot API

@spec approve_chat_join_request(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• user_id: Unique identifier of the target user

@spec approve_chat_join_request!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of approve_chat_join_request/3. It will return the response or raise in case of error.

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec approve_suggested_post(
  chat_id :: integer(),
  message_id :: integer(),
  options :: [
    send_date: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target direct messages chat
• message_id: Identifier of a suggested post message to approve
• send_date (optional): Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future

@spec approve_suggested_post!(
  chat_id :: integer(),
  message_id :: integer(),
  ops :: [
    send_date: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of approve_suggested_post/3. It will return the response or raise in case of error.

Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec ban_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    until_date: integer(),
    revoke_messages: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
• user_id: Unique identifier of the target user
• until_date (optional): Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
• revoke_messages (optional): Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

@spec ban_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    until_date: integer(),
    revoke_messages: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of ban_chat_member/3. It will return the response or raise in case of error.

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec ban_chat_sender_chat(
  chat_id :: integer() | String.t(),
  sender_chat_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• sender_chat_id: Unique identifier of the target sender chat

@spec ban_chat_sender_chat!(
  chat_id :: integer() | String.t(),
  sender_chat_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of ban_chat_sender_chat/3. It will return the response or raise in case of error.

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec close(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Check the documentation of this method on Telegram Bot API

@spec close!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of close/1. It will return the response or raise in case of error.

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Check the documentation of this method on Telegram Bot API

@spec close_forum_topic(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to close an open 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, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• message_thread_id: Unique identifier for the target message thread of the forum topic

@spec close_forum_topic!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of close_forum_topic/3. It will return the response or raise in case of error.

Use this method to close an open 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, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec close_general_forum_topic(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to close an open 'General' 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 True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

@spec close_general_forum_topic!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of close_general_forum_topic/2. It will return the response or raise in case of error.

Use this method to close an open 'General' 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 True on success.

Check the documentation of this method on Telegram Bot API

@spec convert_gift_to_stars(
  business_connection_id :: String.t(),
  owned_gift_id :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection
• owned_gift_id: Unique identifier of the regular gift that should be converted to Telegram Stars

@spec convert_gift_to_stars!(
  business_connection_id :: String.t(),
  owned_gift_id :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of convert_gift_to_stars/3. It will return the response or raise in case of error.

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec copy_message(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    video_start_timestamp: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    show_caption_above_media: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    allow_paid_broadcast: boolean(),
    message_effect_id: String.t(),
    suggested_post_parameters: ExGram.Model.SuggestedPostParameters.t(),
    reply_parameters: ExGram.Model.ReplyParameters.t(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.MessageId.t()} | {:error, ExGram.Error.t()}

Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
• message_id: Message identifier in the chat specified in from_chat_id
• message_thread_id (optional): Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
• direct_messages_topic_id (optional): Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
• video_start_timestamp (optional): New start timestamp for the copied video in the message
• caption (optional): New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept
• parse_mode (optional): Mode for parsing entities in the new caption. See formatting options for more details.
• caption_entities (optional): A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode
• show_caption_above_media (optional): Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.
• disable_notification (optional): Sends the message silently. Users will receive a notification with no sound.
• protect_content (optional): Protects the contents of the sent message from forwarding and saving
• allow_paid_broadcast (optional): Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance
• message_effect_id (optional): Unique identifier of the message effect to be added to the message; only available when copying to private chats
• suggested_post_parameters (optional): A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
• reply_parameters (optional): Description of the message to reply to
• reply_markup (optional): Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

@spec copy_message!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    video_start_timestamp: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    show_caption_above_media: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    allow_paid_broadcast: boolean(),
    message_effect_id: String.t(),
    suggested_post_parameters: ExGram.Model.SuggestedPostParameters.t(),
    reply_parameters: ExGram.Model.ReplyParameters.t(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.MessageId.t()

Unsafe version of copy_message/4. It will return the response or raise in case of error.

Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

Check the documentation of this method on Telegram Bot API

@spec copy_messages(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_ids :: [integer()],
  options :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    remove_caption: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.MessageId.t()]} | {:error, ExGram.Error.t()}

Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• from_chat_id: Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
• message_ids: A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
• message_thread_id (optional): Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
• direct_messages_topic_id (optional): Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
• disable_notification (optional): Sends the messages silently. Users will receive a notification with no sound.
• protect_content (optional): Protects the contents of the sent messages from forwarding and saving
• remove_caption (optional): Pass True to copy the messages without their captions

@spec copy_messages!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_ids :: [integer()],
  ops :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    remove_caption: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.MessageId.t()]

Unsafe version of copy_messages/4. It will return the response or raise in case of error.

Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

Check the documentation of this method on Telegram Bot API

@spec create_chat_invite_link(
  chat_id :: integer() | String.t(),
  options :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• name (optional): Invite link name; 0-32 characters
• expire_date (optional): Point in time (Unix timestamp) when the link will expire
• member_limit (optional): The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
• creates_join_request (optional): True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified

@spec create_chat_invite_link!(
  chat_id :: integer() | String.t(),
  ops :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of create_chat_invite_link/2. It will return the response or raise in case of error.

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Check the documentation of this method on Telegram Bot API

@spec create_chat_subscription_invite_link(
  chat_id :: integer() | String.t(),
  subscription_period :: integer(),
  subscription_price :: integer(),
  options :: [
    name: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

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.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)
• subscription_period: The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).
• subscription_price: The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000
• name (optional): Invite link name; 0-32 characters

@spec create_chat_subscription_invite_link!(
  chat_id :: integer() | String.t(),
  subscription_period :: integer(),
  subscription_price :: integer(),
  ops :: [
    name: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of create_chat_subscription_invite_link/4. It will return the response or raise in case of error.

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.

Check the documentation of this method on Telegram Bot API

@spec create_forum_topic(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  options :: [
    icon_color: integer(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ForumTopic.t()} | {:error, ExGram.Error.t()}

Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• name: Topic name, 1-128 characters
• icon_color (optional): Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)
• icon_custom_emoji_id (optional): Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.

@spec create_forum_topic!(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  ops :: [
    icon_color: integer(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ForumTopic.t()

Unsafe version of create_forum_topic/3. It will return the response or raise in case of error.

Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.

Check the documentation of this method on Telegram Bot API

@spec create_invoice_link(
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  options :: [
    business_connection_id: String.t(),
    provider_token: String.t(),
    subscription_period: integer(),
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    provider_data: String.t(),
    photo_url: String.t(),
    photo_size: integer(),
    photo_width: integer(),
    photo_height: integer(),
    need_name: boolean(),
    need_phone_number: boolean(),
    need_email: boolean(),
    need_shipping_address: boolean(),
    send_phone_number_to_provider: boolean(),
    send_email_to_provider: boolean(),
    is_flexible: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, String.t()} | {:error, ExGram.Error.t()}

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Check the documentation of this method on Telegram Bot API

• title: Product name, 1-32 characters
• description: Product description, 1-255 characters
• payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
• currency: Three-letter ISO 4217 currency code, see more on currencies. Pass "XTR” for payments in Telegram Stars.
• prices: Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
• business_connection_id (optional): Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
• provider_token (optional): Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
• subscription_period (optional): The number of seconds the subscription will be active for before the next payment. The currency must be set to "XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.
• max_tip_amount (optional): The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
• suggested_tip_amounts (optional): A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
• provider_data (optional): JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
• photo_url (optional): URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
• photo_size (optional): Photo size in bytes
• photo_width (optional): Photo width
• photo_height (optional): Photo height
• need_name (optional): Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
• need_phone_number (optional): Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
• need_email (optional): Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
• need_shipping_address (optional): Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
• send_phone_number_to_provider (optional): Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
• send_email_to_provider (optional): Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
• is_flexible (optional): Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

@spec create_invoice_link!(
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  ops :: [
    business_connection_id: String.t(),
    provider_token: String.t(),
    subscription_period: integer(),
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    provider_data: String.t(),
    photo_url: String.t(),
    photo_size: integer(),
    photo_width: integer(),
    photo_height: integer(),
    need_name: boolean(),
    need_phone_number: boolean(),
    need_email: boolean(),
    need_shipping_address: boolean(),
    send_phone_number_to_provider: boolean(),
    send_email_to_provider: boolean(),
    is_flexible: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: String.t()

Unsafe version of create_invoice_link/6. It will return the response or raise in case of error.

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Check the documentation of this method on Telegram Bot API

@spec create_new_sticker_set(
  user_id :: integer(),
  name :: String.t(),
  title :: String.t(),
  stickers :: [ExGram.Model.InputSticker.t()],
  options :: [
    sticker_type: String.t(),
    needs_repainting: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

Check the documentation of this method on Telegram Bot API

• user_id: User identifier of created sticker set owner
• name: Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "by<bot_username>". <bot_username> is case insensitive. 1-64 characters.
• title: Sticker set title, 1-64 characters
• stickers: A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
• sticker_type (optional): Type of stickers in the set, pass "regular”, "mask”, or "custom_emoji”. By default, a regular sticker set is created.
• needs_repainting (optional): Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only

@spec create_new_sticker_set!(
  user_id :: integer(),
  name :: String.t(),
  title :: String.t(),
  stickers :: [ExGram.Model.InputSticker.t()],
  ops :: [
    sticker_type: String.t(),
    needs_repainting: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of create_new_sticker_set/5. It will return the response or raise in case of error.

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec decline_chat_join_request(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• user_id: Unique identifier of the target user

@spec decline_chat_join_request!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of decline_chat_join_request/3. It will return the response or raise in case of error.

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec decline_suggested_post(
  chat_id :: integer(),
  message_id :: integer(),
  options :: [
    comment: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target direct messages chat
• message_id: Identifier of a suggested post message to decline
• comment (optional): Comment for the creator of the suggested post; 0-128 characters

@spec decline_suggested_post!(
  chat_id :: integer(),
  message_id :: integer(),
  ops :: [
    comment: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of decline_suggested_post/3. It will return the response or raise in case of error.

Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_business_messages(
  business_connection_id :: String.t(),
  message_ids :: [integer()],
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection on behalf of which to delete the messages
• message_ids: A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted

@spec delete_business_messages!(
  business_connection_id :: String.t(),
  message_ids :: [integer()],
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_business_messages/3. It will return the response or raise in case of error.

Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_chat_photo(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)

@spec delete_chat_photo!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_chat_photo/2. It will return the response or raise in case of error.

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_chat_sticker_set(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

@spec delete_chat_sticker_set!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_chat_sticker_set/2. It will return the response or raise in case of error.

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_forum_topic(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• message_thread_id: Unique identifier for the target message thread of the forum topic

@spec delete_forum_topic!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_forum_topic/3. It will return the response or raise in case of error.

Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_message(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there. - If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_id: Identifier of the message to delete

@spec delete_message!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_message/3. It will return the response or raise in case of error.

Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there. - If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_messages(
  chat_id :: integer() | String.t(),
  message_ids :: [integer()],
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_ids: A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted

@spec delete_messages!(
  chat_id :: integer() | String.t(),
  message_ids :: [integer()],
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_messages/3. It will return the response or raise in case of error.

Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_my_commands(
  options :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Check the documentation of this method on Telegram Bot API

• scope (optional): A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
• language_code (optional): A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

@spec delete_my_commands!(
  ops :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_my_commands/1. It will return the response or raise in case of error.

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_sticker_from_set(
  sticker :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Check the documentation of this method on Telegram Bot API

• sticker: File identifier of the sticker

@spec delete_sticker_from_set!(
  sticker :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_sticker_from_set/2. It will return the response or raise in case of error.

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_sticker_set(
  name :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete a sticker set that was created by the bot. Returns True on success.

Check the documentation of this method on Telegram Bot API

• name: Sticker set name

@spec delete_sticker_set!(
  name :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_sticker_set/2. It will return the response or raise in case of error.

Use this method to delete a sticker set that was created by the bot. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_story(
  business_connection_id :: String.t(),
  story_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection
• story_id: Unique identifier of the story to delete

@spec delete_story!(
  business_connection_id :: String.t(),
  story_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_story/3. It will return the response or raise in case of error.

Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec delete_webhook(
  options :: [
    drop_pending_updates: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

Check the documentation of this method on Telegram Bot API

• drop_pending_updates (optional): Pass True to drop all pending updates

@spec delete_webhook!(
  ops :: [
    drop_pending_updates: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_webhook/1. It will return the response or raise in case of error.

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec edit_chat_invite_link(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  options :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• invite_link: The invite link to edit
• name (optional): Invite link name; 0-32 characters
• expire_date (optional): Point in time (Unix timestamp) when the link will expire
• member_limit (optional): The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
• creates_join_request (optional): True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified

@spec edit_chat_invite_link!(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  ops :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of edit_chat_invite_link/3. It will return the response or raise in case of error.

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Check the documentation of this method on Telegram Bot API

@spec edit_chat_subscription_invite_link(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  options :: [
    name: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

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.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• invite_link: The invite link to edit
• name (optional): Invite link name; 0-32 characters

@spec edit_chat_subscription_invite_link!(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  ops :: [
    name: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of edit_chat_subscription_invite_link/3. It will return the response or raise in case of error.

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.

Check the documentation of this method on Telegram Bot API

@spec edit_forum_topic(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    name: String.t(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in 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.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• message_thread_id: Unique identifier for the target message thread of the forum topic
• name (optional): New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept
• icon_custom_emoji_id (optional): New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept

@spec edit_forum_topic!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    name: String.t(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of edit_forum_topic/3. It will return the response or raise in case of error.

Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in 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.

Check the documentation of this method on Telegram Bot API

@spec edit_general_forum_topic(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 the can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• name: New topic name, 1-128 characters

@spec edit_general_forum_topic!(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of edit_general_forum_topic/3. It will return the response or raise in case of error.

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 the can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec edit_message_caption(
  options :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    show_caption_above_media: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t() | true} | {:error, ExGram.Error.t()}

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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

• business_connection_id (optional): Unique identifier of the business connection on behalf of which the message to be edited was sent
• chat_id (optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_id (optional): Required if inline_message_id is not specified. Identifier of the message to edit
• inline_message_id (optional): Required if chat_id and message_id are not specified. Identifier of the inline message
• caption (optional): New caption of the message, 0-1024 characters after entities parsing
• parse_mode (optional): Mode for parsing entities in the message caption. See formatting options for more details.
• caption_entities (optional): A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
• show_caption_above_media (optional): Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
• reply_markup (optional): A JSON-serialized object for an inline keyboard.

@spec edit_message_caption!(
  ops :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    show_caption_above_media: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t() | true

Unsafe version of edit_message_caption/1. It will return the response or raise in case of error.

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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

@spec edit_message_checklist(
  business_connection_id :: String.t(),
  chat_id :: integer(),
  message_id :: integer(),
  checklist :: ExGram.Model.InputChecklist.t(),
  options :: [
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection on behalf of which the message will be sent
• chat_id: Unique identifier for the target chat
• message_id: Unique identifier for the target message
• checklist: A JSON-serialized object for the new checklist
• reply_markup (optional): A JSON-serialized object for the new inline keyboard for the message

@spec edit_message_checklist!(
  business_connection_id :: String.t(),
  chat_id :: integer(),
  message_id :: integer(),
  checklist :: ExGram.Model.InputChecklist.t(),
  ops :: [
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_checklist/5. It will return the response or raise in case of error.

Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

Check the documentation of this method on Telegram Bot API

@spec edit_message_live_location(
  latitude :: float(),
  longitude :: float(),
  options :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    live_period: integer(),
    horizontal_accuracy: float(),
    heading: integer(),
    proximity_alert_radius: integer(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t() | true} | {:error, ExGram.Error.t()}

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method on Telegram Bot API

• latitude: Latitude of new location
• longitude: Longitude of new location
• business_connection_id (optional): Unique identifier of the business connection on behalf of which the message to be edited was sent
• chat_id (optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_id (optional): Required if inline_message_id is not specified. Identifier of the message to edit
• inline_message_id (optional): Required if chat_id and message_id are not specified. Identifier of the inline message
• live_period (optional): New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged
• horizontal_accuracy (optional): The radius of uncertainty for the location, measured in meters; 0-1500
• heading (optional): Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
• proximity_alert_radius (optional): The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
• reply_markup (optional): A JSON-serialized object for a new inline keyboard.

@spec edit_message_live_location!(
  latitude :: float(),
  longitude :: float(),
  ops :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    live_period: integer(),
    horizontal_accuracy: float(),
    heading: integer(),
    proximity_alert_radius: integer(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t() | true

Unsafe version of edit_message_live_location/3. It will return the response or raise in case of error.

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method on Telegram Bot API

@spec edit_message_media(
  media :: ExGram.Model.InputMedia.t(),
  options :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t() | true} | {:error, ExGram.Error.t()}

Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

• media: A JSON-serialized object for a new media content of the message
• business_connection_id (optional): Unique identifier of the business connection on behalf of which the message to be edited was sent
• chat_id (optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_id (optional): Required if inline_message_id is not specified. Identifier of the message to edit
• inline_message_id (optional): Required if chat_id and message_id are not specified. Identifier of the inline message
• reply_markup (optional): A JSON-serialized object for a new inline keyboard.

@spec edit_message_media!(
  media :: ExGram.Model.InputMedia.t(),
  ops :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t() | true

Unsafe version of edit_message_media/2. It will return the response or raise in case of error.

Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

@spec edit_message_reply_markup(
  options :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t() | true} | {:error, ExGram.Error.t()}

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

• business_connection_id (optional): Unique identifier of the business connection on behalf of which the message to be edited was sent
• chat_id (optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_id (optional): Required if inline_message_id is not specified. Identifier of the message to edit
• inline_message_id (optional): Required if chat_id and message_id are not specified. Identifier of the inline message
• reply_markup (optional): A JSON-serialized object for an inline keyboard.

@spec edit_message_reply_markup!(
  ops :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t() | true

Unsafe version of edit_message_reply_markup/1. It will return the response or raise in case of error.

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

@spec edit_message_text(
  text :: String.t(),
  options :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    link_preview_options: ExGram.Model.LinkPreviewOptions.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t() | true} | {:error, ExGram.Error.t()}

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

• text: New text of the message, 1-4096 characters after entities parsing
• business_connection_id (optional): Unique identifier of the business connection on behalf of which the message to be edited was sent
• chat_id (optional): Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_id (optional): Required if inline_message_id is not specified. Identifier of the message to edit
• inline_message_id (optional): Required if chat_id and message_id are not specified. Identifier of the inline message
• parse_mode (optional): Mode for parsing entities in the message text. See formatting options for more details.
• entities (optional): A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
• link_preview_options (optional): Link preview generation options for the message
• reply_markup (optional): A JSON-serialized object for an inline keyboard.

@spec edit_message_text!(
  text :: String.t(),
  ops :: [
    business_connection_id: String.t(),
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    link_preview_options: ExGram.Model.LinkPreviewOptions.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t() | true

Unsafe version of edit_message_text/2. It will return the response or raise in case of error.

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Check the documentation of this method on Telegram Bot API

@spec edit_story(
  business_connection_id :: String.t(),
  story_id :: integer(),
  content :: ExGram.Model.InputStoryContent.t(),
  options :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    areas: [ExGram.Model.StoryArea.t()],
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Story.t()} | {:error, ExGram.Error.t()}

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection
• story_id: Unique identifier of the story to edit
• content: Content of the story
• caption (optional): Caption of the story, 0-2048 characters after entities parsing
• parse_mode (optional): Mode for parsing entities in the story caption. See formatting options for more details.
• caption_entities (optional): A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
• areas (optional): A JSON-serialized list of clickable areas to be shown on the story

@spec edit_story!(
  business_connection_id :: String.t(),
  story_id :: integer(),
  content :: ExGram.Model.InputStoryContent.t(),
  ops :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    areas: [ExGram.Model.StoryArea.t()],
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Story.t()

Unsafe version of edit_story/4. It will return the response or raise in case of error.

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Check the documentation of this method on Telegram Bot API

@spec edit_user_star_subscription(
  user_id :: integer(),
  telegram_payment_charge_id :: String.t(),
  is_canceled :: boolean(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

Check the documentation of this method on Telegram Bot API

• user_id: Identifier of the user whose subscription will be edited
• telegram_payment_charge_id: Telegram payment identifier for the subscription
• is_canceled: Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.

@spec edit_user_star_subscription!(
  user_id :: integer(),
  telegram_payment_charge_id :: String.t(),
  is_canceled :: boolean(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of edit_user_star_subscription/4. It will return the response or raise in case of error.

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec export_chat_invite_link(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, String.t()} | {:error, ExGram.Error.t()}

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)

@spec export_chat_invite_link!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: String.t()

Unsafe version of export_chat_invite_link/2. It will return the response or raise in case of error.

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Check the documentation of this method on Telegram Bot API

@spec forward_message(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    video_start_timestamp: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    message_effect_id: String.t(),
    suggested_post_parameters: ExGram.Model.SuggestedPostParameters.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
• message_id: Message identifier in the chat specified in from_chat_id
• message_thread_id (optional): Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
• direct_messages_topic_id (optional): Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat
• video_start_timestamp (optional): New start timestamp for the forwarded video in the message
• disable_notification (optional): Sends the message silently. Users will receive a notification with no sound.
• protect_content (optional): Protects the contents of the forwarded message from forwarding and saving
• message_effect_id (optional): Unique identifier of the message effect to be added to the message; only available when forwarding to private chats
• suggested_post_parameters (optional): A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only

@spec forward_message!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    video_start_timestamp: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    message_effect_id: String.t(),
    suggested_post_parameters: ExGram.Model.SuggestedPostParameters.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of forward_message/4. It will return the response or raise in case of error.

Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.

Check the documentation of this method on Telegram Bot API

@spec forward_messages(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_ids :: [integer()],
  options :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.MessageId.t()]} | {:error, ExGram.Error.t()}

Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• from_chat_id: Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
• message_ids: A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.
• message_thread_id (optional): Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
• direct_messages_topic_id (optional): Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat
• disable_notification (optional): Sends the messages silently. Users will receive a notification with no sound.
• protect_content (optional): Protects the contents of the forwarded messages from forwarding and saving

@spec forward_messages!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_ids :: [integer()],
  ops :: [
    message_thread_id: integer(),
    direct_messages_topic_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.MessageId.t()]

Unsafe version of forward_messages/4. It will return the response or raise in case of error.

Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

Check the documentation of this method on Telegram Bot API

@spec get_available_gifts(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Gifts.t()} | {:error, ExGram.Error.t()}

Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.

Check the documentation of this method on Telegram Bot API

@spec get_available_gifts!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Gifts.t()

Unsafe version of get_available_gifts/1. It will return the response or raise in case of error.

Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.

Check the documentation of this method on Telegram Bot API

@spec get_business_account_gifts(
  business_connection_id :: String.t(),
  options :: [
    exclude_unsaved: boolean(),
    exclude_saved: boolean(),
    exclude_unlimited: boolean(),
    exclude_limited_upgradable: boolean(),
    exclude_limited_non_upgradable: boolean(),
    exclude_unique: boolean(),
    exclude_from_blockchain: boolean(),
    sort_by_price: boolean(),
    offset: String.t(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.OwnedGifts.t()} | {:error, ExGram.Error.t()}

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection
• exclude_unsaved (optional): Pass True to exclude gifts that aren't saved to the account's profile page
• exclude_saved (optional): Pass True to exclude gifts that are saved to the account's profile page
• exclude_unlimited (optional): Pass True to exclude gifts that can be purchased an unlimited number of times
• exclude_limited_upgradable (optional): Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
• exclude_limited_non_upgradable (optional): Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
• exclude_unique (optional): Pass True to exclude unique gifts
• exclude_from_blockchain (optional): Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
• sort_by_price (optional): Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
• offset (optional): Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
• limit (optional): The maximum number of gifts to be returned; 1-100. Defaults to 100

@spec get_business_account_gifts!(
  business_connection_id :: String.t(),
  ops :: [
    exclude_unsaved: boolean(),
    exclude_saved: boolean(),
    exclude_unlimited: boolean(),
    exclude_limited_upgradable: boolean(),
    exclude_limited_non_upgradable: boolean(),
    exclude_unique: boolean(),
    exclude_from_blockchain: boolean(),
    sort_by_price: boolean(),
    offset: String.t(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.OwnedGifts.t()

Unsafe version of get_business_account_gifts/2. It will return the response or raise in case of error.

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

Check the documentation of this method on Telegram Bot API

@spec get_business_account_star_balance(
  business_connection_id :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.StarAmount.t()} | {:error, ExGram.Error.t()}

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection

@spec get_business_account_star_balance!(
  business_connection_id :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.StarAmount.t()

Unsafe version of get_business_account_star_balance/2. It will return the response or raise in case of error.

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

Check the documentation of this method on Telegram Bot API

@spec get_business_connection(
  business_connection_id :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.BusinessConnection.t()} | {:error, ExGram.Error.t()}

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection

@spec get_business_connection!(
  business_connection_id :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.BusinessConnection.t()

Unsafe version of get_business_connection/2. It will return the response or raise in case of error.

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Check the documentation of this method on Telegram Bot API

@spec get_chat(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatFullInfo.t()} | {:error, ExGram.Error.t()}

Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

@spec get_chat!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatFullInfo.t()

Unsafe version of get_chat/2. It will return the response or raise in case of error.

Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.

Check the documentation of this method on Telegram Bot API

@spec get_chat_administrators(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.ChatMember.t()]} | {:error, ExGram.Error.t()}

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

@spec get_chat_administrators!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.ChatMember.t()]

Unsafe version of get_chat_administrators/2. It will return the response or raise in case of error.

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

Check the documentation of this method on Telegram Bot API

@spec get_chat_gifts(
  chat_id :: integer() | String.t(),
  options :: [
    exclude_unsaved: boolean(),
    exclude_saved: boolean(),
    exclude_unlimited: boolean(),
    exclude_limited_upgradable: boolean(),
    exclude_limited_non_upgradable: boolean(),
    exclude_from_blockchain: boolean(),
    exclude_unique: boolean(),
    sort_by_price: boolean(),
    offset: String.t(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.OwnedGifts.t()} | {:error, ExGram.Error.t()}

Returns the gifts owned by a chat. Returns OwnedGifts on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• exclude_unsaved (optional): Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.
• exclude_saved (optional): Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.
• exclude_unlimited (optional): Pass True to exclude gifts that can be purchased an unlimited number of times
• exclude_limited_upgradable (optional): Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
• exclude_limited_non_upgradable (optional): Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
• exclude_from_blockchain (optional): Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
• exclude_unique (optional): Pass True to exclude unique gifts
• sort_by_price (optional): Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
• offset (optional): Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
• limit (optional): The maximum number of gifts to be returned; 1-100. Defaults to 100

@spec get_chat_gifts!(
  chat_id :: integer() | String.t(),
  ops :: [
    exclude_unsaved: boolean(),
    exclude_saved: boolean(),
    exclude_unlimited: boolean(),
    exclude_limited_upgradable: boolean(),
    exclude_limited_non_upgradable: boolean(),
    exclude_from_blockchain: boolean(),
    exclude_unique: boolean(),
    sort_by_price: boolean(),
    offset: String.t(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.OwnedGifts.t()

Unsafe version of get_chat_gifts/2. It will return the response or raise in case of error.

Returns the gifts owned by a chat. Returns OwnedGifts on success.

Check the documentation of this method on Telegram Bot API

@spec get_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatMember.t()} | {:error, ExGram.Error.t()}

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
• user_id: Unique identifier of the target user

@spec get_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatMember.t()

Unsafe version of get_chat_member/3. It will return the response or raise in case of error.

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

Check the documentation of this method on Telegram Bot API

@spec get_chat_member_count(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, integer()} | {:error, ExGram.Error.t()}

Use this method to get the number of members in a chat. Returns Int on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

@spec get_chat_member_count!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: integer()

Unsafe version of get_chat_member_count/2. It will return the response or raise in case of error.

Use this method to get the number of members in a chat. Returns Int on success.

Check the documentation of this method on Telegram Bot API

@spec get_chat_menu_button(
  options :: [
    chat_id: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.MenuButton.t()} | {:error, ExGram.Error.t()}

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.

Check the documentation of this method on Telegram Bot API

• chat_id (optional): Unique identifier for the target private chat. If not specified, default bot's menu button will be returned

@spec get_chat_menu_button!(
  ops :: [
    chat_id: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.MenuButton.t()

Unsafe version of get_chat_menu_button/1. It will return the response or raise in case of error.

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.

Check the documentation of this method on Telegram Bot API

@spec get_custom_emoji_stickers(
  custom_emoji_ids :: [String.t()],
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.Sticker.t()]} | {:error, ExGram.Error.t()}

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Check the documentation of this method on Telegram Bot API

• custom_emoji_ids: A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

@spec get_custom_emoji_stickers!(
  custom_emoji_ids :: [String.t()],
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.Sticker.t()]

Unsafe version of get_custom_emoji_stickers/2. It will return the response or raise in case of error.

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Check the documentation of this method on Telegram Bot API

@spec get_file(
  file_id :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.File.t()} | {:error, ExGram.Error.t()}

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.

Check the documentation of this method on Telegram Bot API

• file_id: File identifier to get information about

@spec get_file!(
  file_id :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.File.t()

Unsafe version of get_file/2. It will return the response or raise in case of error.

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.

Check the documentation of this method on Telegram Bot API

@spec get_forum_topic_icon_stickers(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.Sticker.t()]} | {:error, ExGram.Error.t()}

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Check the documentation of this method on Telegram Bot API

@spec get_forum_topic_icon_stickers!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.Sticker.t()]

Unsafe version of get_forum_topic_icon_stickers/1. It will return the response or raise in case of error.

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Check the documentation of this method on Telegram Bot API

@spec get_game_high_scores(
  user_id :: integer(),
  options :: [
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.GameHighScore.t()]} | {:error, ExGram.Error.t()}

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

Check the documentation of this method on Telegram Bot API

• user_id: Target user id
• chat_id (optional): Required if inline_message_id is not specified. Unique identifier for the target chat
• message_id (optional): Required if inline_message_id is not specified. Identifier of the sent message
• inline_message_id (optional): Required if chat_id and message_id are not specified. Identifier of the inline message

@spec get_game_high_scores!(
  user_id :: integer(),
  ops :: [
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.GameHighScore.t()]

Unsafe version of get_game_high_scores/2. It will return the response or raise in case of error.

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

Check the documentation of this method on Telegram Bot API

@spec get_me(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.User.t()} | {:error, ExGram.Error.t()}

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Check the documentation of this method on Telegram Bot API

@spec get_me!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.User.t()

Unsafe version of get_me/1. It will return the response or raise in case of error.

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Check the documentation of this method on Telegram Bot API

@spec get_my_commands(
  options :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.BotCommand.t()]} | {:error, ExGram.Error.t()}

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

Check the documentation of this method on Telegram Bot API

• scope (optional): A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.
• language_code (optional): A two-letter ISO 639-1 language code or an empty string

@spec get_my_commands!(
  ops :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.BotCommand.t()]

Unsafe version of get_my_commands/1. It will return the response or raise in case of error.

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

Check the documentation of this method on Telegram Bot API

@spec get_my_default_administrator_rights(
  options :: [
    for_channels: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) ::
  {:ok, ExGram.Model.ChatAdministratorRights.t()} | {:error, ExGram.Error.t()}

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Check the documentation of this method on Telegram Bot API

• for_channels (optional): Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

@spec get_my_default_administrator_rights!(
  ops :: [
    for_channels: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatAdministratorRights.t()

Unsafe version of get_my_default_administrator_rights/1. It will return the response or raise in case of error.

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Check the documentation of this method on Telegram Bot API

@spec get_my_description(
  options :: [
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.BotDescription.t()} | {:error, ExGram.Error.t()}

Use this method to get the current bot description for the given user language. Returns BotDescription on success.

Check the documentation of this method on Telegram Bot API

• language_code (optional): A two-letter ISO 639-1 language code or an empty string

@spec get_my_description!(
  ops :: [
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.BotDescription.t()

Unsafe version of get_my_description/1. It will return the response or raise in case of error.

Use this method to get the current bot description for the given user language. Returns BotDescription on success.

Check the documentation of this method on Telegram Bot API

@spec get_my_name(
  options :: [
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.BotName.t()} | {:error, ExGram.Error.t()}

Use this method to get the current bot name for the given user language. Returns BotName on success.

Check the documentation of this method on Telegram Bot API

• language_code (optional): A two-letter ISO 639-1 language code or an empty string

@spec get_my_name!(
  ops :: [
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.BotName.t()

Unsafe version of get_my_name/1. It will return the response or raise in case of error.

Use this method to get the current bot name for the given user language. Returns BotName on success.

Check the documentation of this method on Telegram Bot API

@spec get_my_short_description(
  options :: [
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.BotShortDescription.t()} | {:error, ExGram.Error.t()}

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

Check the documentation of this method on Telegram Bot API

• language_code (optional): A two-letter ISO 639-1 language code or an empty string

@spec get_my_short_description!(
  ops :: [
    language_code: String.t(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.BotShortDescription.t()

Unsafe version of get_my_short_description/1. It will return the response or raise in case of error.

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

Check the documentation of this method on Telegram Bot API

@spec get_my_star_balance(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.StarAmount.t()} | {:error, ExGram.Error.t()}

A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

Check the documentation of this method on Telegram Bot API

@spec get_my_star_balance!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.StarAmount.t()

Unsafe version of get_my_star_balance/1. It will return the response or raise in case of error.

A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

Check the documentation of this method on Telegram Bot API

@spec get_star_transactions(
  options :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.StarTransactions.t()} | {:error, ExGram.Error.t()}

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

Check the documentation of this method on Telegram Bot API

• offset (optional): Number of transactions to skip in the response
• limit (optional): The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.

@spec get_star_transactions!(
  ops :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.StarTransactions.t()

Unsafe version of get_star_transactions/1. It will return the response or raise in case of error.

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

Check the documentation of this method on Telegram Bot API

@spec get_sticker_set(
  name :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.StickerSet.t()} | {:error, ExGram.Error.t()}

Use this method to get a sticker set. On success, a StickerSet object is returned.

Check the documentation of this method on Telegram Bot API

• name: Name of the sticker set

@spec get_sticker_set!(
  name :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.StickerSet.t()

Unsafe version of get_sticker_set/2. It will return the response or raise in case of error.

Use this method to get a sticker set. On success, a StickerSet object is returned.

Check the documentation of this method on Telegram Bot API

@spec get_updates(
  options :: [
    offset: integer(),
    limit: integer(),
    timeout: integer(),
    allowed_updates: [String.t()],
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, [ExGram.Model.Update.t()]} | {:error, ExGram.Error.t()}

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Check the documentation of this method on Telegram Bot API

• offset (optional): Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.
• limit (optional): Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
• timeout (optional): Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
• allowed_updates (optional): A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.

@spec get_updates!(
  ops :: [
    offset: integer(),
    limit: integer(),
    timeout: integer(),
    allowed_updates: [String.t()],
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: [ExGram.Model.Update.t()]

Unsafe version of get_updates/1. It will return the response or raise in case of error.

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Check the documentation of this method on Telegram Bot API

@spec get_user_chat_boosts(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.UserChatBoosts.t()} | {:error, ExGram.Error.t()}

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the chat or username of the channel (in the format @channelusername)
• user_id: Unique identifier of the target user

@spec get_user_chat_boosts!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.UserChatBoosts.t()

Unsafe version of get_user_chat_boosts/3. It will return the response or raise in case of error.

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

Check the documentation of this method on Telegram Bot API

@spec get_user_gifts(
  user_id :: integer(),
  options :: [
    exclude_unlimited: boolean(),
    exclude_limited_upgradable: boolean(),
    exclude_limited_non_upgradable: boolean(),
    exclude_from_blockchain: boolean(),
    exclude_unique: boolean(),
    sort_by_price: boolean(),
    offset: String.t(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.OwnedGifts.t()} | {:error, ExGram.Error.t()}

Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

Check the documentation of this method on Telegram Bot API

• user_id: Unique identifier of the user
• exclude_unlimited (optional): Pass True to exclude gifts that can be purchased an unlimited number of times
• exclude_limited_upgradable (optional): Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
• exclude_limited_non_upgradable (optional): Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
• exclude_from_blockchain (optional): Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
• exclude_unique (optional): Pass True to exclude unique gifts
• sort_by_price (optional): Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
• offset (optional): Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
• limit (optional): The maximum number of gifts to be returned; 1-100. Defaults to 100

@spec get_user_gifts!(
  user_id :: integer(),
  ops :: [
    exclude_unlimited: boolean(),
    exclude_limited_upgradable: boolean(),
    exclude_limited_non_upgradable: boolean(),
    exclude_from_blockchain: boolean(),
    exclude_unique: boolean(),
    sort_by_price: boolean(),
    offset: String.t(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.OwnedGifts.t()

Unsafe version of get_user_gifts/2. It will return the response or raise in case of error.

Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

Check the documentation of this method on Telegram Bot API

@spec get_user_profile_audios(
  user_id :: integer(),
  options :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.UserProfileAudios.t()} | {:error, ExGram.Error.t()}

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

Check the documentation of this method on Telegram Bot API

• user_id: Unique identifier of the target user
• offset (optional): Sequential number of the first audio to be returned. By default, all audios are returned.
• limit (optional): Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.

@spec get_user_profile_audios!(
  user_id :: integer(),
  ops :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.UserProfileAudios.t()

Unsafe version of get_user_profile_audios/2. It will return the response or raise in case of error.

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

Check the documentation of this method on Telegram Bot API

@spec get_user_profile_photos(
  user_id :: integer(),
  options :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.UserProfilePhotos.t()} | {:error, ExGram.Error.t()}

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Check the documentation of this method on Telegram Bot API

• user_id: Unique identifier of the target user
• offset (optional): Sequential number of the first photo to be returned. By default, all photos are returned.
• limit (optional): Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.

@spec get_user_profile_photos!(
  user_id :: integer(),
  ops :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.UserProfilePhotos.t()

Unsafe version of get_user_profile_photos/2. It will return the response or raise in case of error.

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Check the documentation of this method on Telegram Bot API

@spec get_webhook_info(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.WebhookInfo.t()} | {:error, ExGram.Error.t()}

Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

Check the documentation of this method on Telegram Bot API

@spec get_webhook_info!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.WebhookInfo.t()

Unsafe version of get_webhook_info/1. It will return the response or raise in case of error.

Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

Check the documentation of this method on Telegram Bot API

@spec gift_premium_subscription(
  user_id :: integer(),
  month_count :: integer(),
  star_count :: integer(),
  options :: [
    text: String.t(),
    text_parse_mode: String.t(),
    text_entities: [ExGram.Model.MessageEntity.t()],
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Gifts a Telegram Premium subscription to the given user. Returns True on success.

Check the documentation of this method on Telegram Bot API

• user_id: Unique identifier of the target user who will receive a Telegram Premium subscription
• month_count: Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12
• star_count: Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months
• text (optional): Text that will be shown along with the service message about the subscription; 0-128 characters
• text_parse_mode (optional): Mode for parsing entities in the text. See formatting options for more details. Entities other than "bold”, "italic”, "underline”, "strikethrough”, "spoiler”, and "custom_emoji” are ignored.
• text_entities (optional): A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than "bold”, "italic”, "underline”, "strikethrough”, "spoiler”, and "custom_emoji” are ignored.

@spec gift_premium_subscription!(
  user_id :: integer(),
  month_count :: integer(),
  star_count :: integer(),
  ops :: [
    text: String.t(),
    text_parse_mode: String.t(),
    text_entities: [ExGram.Model.MessageEntity.t()],
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of gift_premium_subscription/4. It will return the response or raise in case of error.

Gifts a Telegram Premium subscription to the given user. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec hide_general_forum_topic(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to hide the 'General' 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. The topic will be automatically closed if it was open. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

@spec hide_general_forum_topic!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of hide_general_forum_topic/2. It will return the response or raise in case of error.

Use this method to hide the 'General' 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. The topic will be automatically closed if it was open. Returns True on success.

Check the documentation of this method on Telegram Bot API

Callback implementation for Supervisor.init/1.

@spec leave_chat(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername). Channel direct messages chats aren't supported; leave the corresponding channel instead.

@spec leave_chat!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of leave_chat/2. It will return the response or raise in case of error.

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec log_out(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Check the documentation of this method on Telegram Bot API

@spec log_out!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of log_out/1. It will return the response or raise in case of error.

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Check the documentation of this method on Telegram Bot API

@spec pin_chat_message(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    business_connection_id: String.t(),
    disable_notification: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• message_id: Identifier of a message to pin
• business_connection_id (optional): Unique identifier of the business connection on behalf of which the message will be pinned
• disable_notification (optional): Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

@spec pin_chat_message!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    business_connection_id: String.t(),
    disable_notification: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of pin_chat_message/3. It will return the response or raise in case of error.

Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec post_story(
  business_connection_id :: String.t(),
  content :: ExGram.Model.InputStoryContent.t(),
  active_period :: integer(),
  options :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    areas: [ExGram.Model.StoryArea.t()],
    post_to_chat_page: boolean(),
    protect_content: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Story.t()} | {:error, ExGram.Error.t()}

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection
• content: Content of the story
• active_period: Period after which the story is moved to the archive, in seconds; must be one of 6 3600, 12 3600, 86400, or 2 * 86400
• caption (optional): Caption of the story, 0-2048 characters after entities parsing
• parse_mode (optional): Mode for parsing entities in the story caption. See formatting options for more details.
• caption_entities (optional): A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
• areas (optional): A JSON-serialized list of clickable areas to be shown on the story
• post_to_chat_page (optional): Pass True to keep the story accessible after it expires
• protect_content (optional): Pass True if the content of the story must be protected from forwarding and screenshotting

@spec post_story!(
  business_connection_id :: String.t(),
  content :: ExGram.Model.InputStoryContent.t(),
  active_period :: integer(),
  ops :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    areas: [ExGram.Model.StoryArea.t()],
    post_to_chat_page: boolean(),
    protect_content: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Story.t()

Unsafe version of post_story/4. It will return the response or raise in case of error.

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Check the documentation of this method on Telegram Bot API

@spec promote_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    is_anonymous: boolean(),
    can_manage_chat: boolean(),
    can_delete_messages: boolean(),
    can_manage_video_chats: boolean(),
    can_restrict_members: boolean(),
    can_promote_members: boolean(),
    can_change_info: boolean(),
    can_invite_users: boolean(),
    can_post_stories: boolean(),
    can_edit_stories: boolean(),
    can_delete_stories: boolean(),
    can_post_messages: boolean(),
    can_edit_messages: boolean(),
    can_pin_messages: boolean(),
    can_manage_topics: boolean(),
    can_manage_direct_messages: boolean(),
    can_manage_tags: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• user_id: Unique identifier of the target user
• is_anonymous (optional): Pass True if the administrator's presence in the chat is hidden
• can_manage_chat (optional): Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
• can_delete_messages (optional): Pass True if the administrator can delete messages of other users
• can_manage_video_chats (optional): Pass True if the administrator can manage video chats
• can_restrict_members (optional): Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators
• can_promote_members (optional): Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)
• can_change_info (optional): Pass True if the administrator can change chat title, photo and other settings
• can_invite_users (optional): Pass True if the administrator can invite new users to the chat
• can_post_stories (optional): Pass True if the administrator can post stories to the chat
• can_edit_stories (optional): Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
• can_delete_stories (optional): Pass True if the administrator can delete stories posted by other users
• can_post_messages (optional): Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
• can_edit_messages (optional): Pass True if the administrator can edit messages of other users and can pin messages; for channels only
• can_pin_messages (optional): Pass True if the administrator can pin messages; for supergroups only
• can_manage_topics (optional): Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
• can_manage_direct_messages (optional): Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only
• can_manage_tags (optional): Pass True if the administrator can edit the tags of regular members; for groups and supergroups only

@spec promote_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    is_anonymous: boolean(),
    can_manage_chat: boolean(),
    can_delete_messages: boolean(),
    can_manage_video_chats: boolean(),
    can_restrict_members: boolean(),
    can_promote_members: boolean(),
    can_change_info: boolean(),
    can_invite_users: boolean(),
    can_post_stories: boolean(),
    can_edit_stories: boolean(),
    can_delete_stories: boolean(),
    can_post_messages: boolean(),
    can_edit_messages: boolean(),
    can_pin_messages: boolean(),
    can_manage_topics: boolean(),
    can_manage_direct_messages: boolean(),
    can_manage_tags: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of promote_chat_member/3. It will return the response or raise in case of error.

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec read_business_message(
  business_connection_id :: String.t(),
  chat_id :: integer(),
  message_id :: integer(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection on behalf of which to read the message
• chat_id: Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.
• message_id: Unique identifier of the message to mark as read

@spec read_business_message!(
  business_connection_id :: String.t(),
  chat_id :: integer(),
  message_id :: integer(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of read_business_message/4. It will return the response or raise in case of error.

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec refund_star_payment(
  user_id :: integer(),
  telegram_payment_charge_id :: String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Refunds a successful payment in Telegram Stars. Returns True on success.

Check the documentation of this method on Telegram Bot API

• user_id: Identifier of the user whose payment will be refunded
• telegram_payment_charge_id: Telegram payment identifier

@spec refund_star_payment!(
  user_id :: integer(),
  telegram_payment_charge_id :: String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of refund_star_payment/3. It will return the response or raise in case of error.

Refunds a successful payment in Telegram Stars. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec remove_business_account_profile_photo(
  business_connection_id :: String.t(),
  options :: [
    is_public: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

• business_connection_id: Unique identifier of the business connection
• is_public (optional): Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.

@spec remove_business_account_profile_photo!(
  business_connection_id :: String.t(),
  ops :: [
    is_public: boolean(),
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of remove_business_account_profile_photo/2. It will return the response or raise in case of error.

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec remove_chat_verification(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

Check the documentation of this method on Telegram Bot API

• chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)

@spec remove_chat_verification!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of remove_chat_verification/2. It will return the response or raise in case of error.

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec remove_my_profile_photo(
  options :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Removes the profile photo of the bot. Requires no parameters. Returns True on success.

Check the documentation of this method on Telegram Bot API

@spec remove_my_profile_photo!(
  ops :: [
    adapter: atom(),
    adapter_opts: keyword(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of remove_my_profile_photo/1. It will return the response or raise in case of error.