pub type AcceptedGiftTypes {
  AcceptedGiftTypes(
    unlimited_gifts: Bool,
    limited_gifts: Bool,
    unique_gifts: Bool,
    premium_subscription: Bool,
    gifts_from_channels: Bool,
  )
}

Constructors

• AcceptedGiftTypes(
    unlimited_gifts: Bool,
    limited_gifts: Bool,
    unique_gifts: Bool,
    premium_subscription: Bool,
    gifts_from_channels: Bool,
  )

  Arguments

  unlimited_gifts

  True, if unlimited regular gifts are accepted

  limited_gifts

  True, if limited regular gifts are accepted

  unique_gifts

  True, if unique gifts or gifts that can be upgraded to unique for free are accepted

  premium_subscription

  True, if a Telegram Premium subscription is accepted

  gifts_from_channels

  True, if transfers of unique gifts from channels are accepted

pub type AddStickerToSetParameters {
  AddStickerToSetParameters(
    user_id: Int,
    name: String,
    sticker: InputSticker,
  )
}

Constructors

• AddStickerToSetParameters(
    user_id: Int,
    name: String,
    sticker: InputSticker,
  )

  Arguments

  user_id

  User identifier of sticker set owner

  name

  Sticker set name

  sticker

  A JSON-serialized object with information about the added sticker

pub type AffiliateInfo {
  AffiliateInfo(
    affiliate_user: option.Option(User),
    affiliate_chat: option.Option(Chat),
    commission_per_mille: Int,
    amount: Int,
    nanostar_amount: option.Option(Int),
  )
}

Constructors

• AffiliateInfo(
    affiliate_user: option.Option(User),
    affiliate_chat: option.Option(Chat),
    commission_per_mille: Int,
    amount: Int,
    nanostar_amount: option.Option(Int),
  )

  Arguments

  affiliate_user

  Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user

  affiliate_chat

  Optional. The chat that received an affiliate commission if it was received by a chat

  commission_per_mille

  The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users

  amount

  Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds

  nanostar_amount

  Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds

pub type Animation {
  Animation(
    file_id: String,
    file_unique_id: String,
    width: Int,
    height: Int,
    duration: Int,
    thumbnail: option.Option(PhotoSize),
    file_name: option.Option(String),
    mime_type: option.Option(String),
    file_size: option.Option(Int),
  )
}

Constructors

• Animation(
    file_id: String,
    file_unique_id: String,
    width: Int,
    height: Int,
    duration: Int,
    thumbnail: option.Option(PhotoSize),
    file_name: option.Option(String),
    mime_type: option.Option(String),
    file_size: option.Option(Int),
  )

  Arguments

  file_id

  Identifier for this file, which can be used to download or reuse the file

  file_unique_id

  Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

  width

  Video width as defined by the sender

  height

  Video height as defined by the sender

  duration

  Duration of the video in seconds as defined by the sender

  thumbnail

  Optional. Animation thumbnail as defined by the sender

  file_name

  Optional. Original animation filename as defined by the sender

  mime_type

  Optional. MIME type of the file as defined by the sender

  file_size

  Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

pub type AnswerCallbackQueryParameters {
  AnswerCallbackQueryParameters(
    callback_query_id: String,
    text: option.Option(String),
    show_alert: option.Option(Bool),
    url: option.Option(String),
    cache_time: option.Option(Int),
  )
}

Constructors

• AnswerCallbackQueryParameters(
    callback_query_id: String,
    text: option.Option(String),
    show_alert: option.Option(Bool),
    url: option.Option(String),
    cache_time: option.Option(Int),
  )

  Arguments

  callback_query_id

  Unique identifier for the query to be answered

  text

  Text of the notification. If not specified, nothing will be shown to the user

  show_alert

  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

  URL that will be opened by the user’s client. If you have created a Game, you can use this field to redirect the player to your game

  cache_time

  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.

pub type AnswerChatJoinRequestQueryParameters {
  AnswerChatJoinRequestQueryParameters(
    chat_join_request_query_id: String,
    result: String,
  )
}

Constructors

• AnswerChatJoinRequestQueryParameters(
    chat_join_request_query_id: String,
    result: String,
  )

  Arguments

  chat_join_request_query_id

  Unique identifier of the join request query as returned in ChatJoinRequest.query_id

  result

  Result of the join request query, one of “approved”, “declined” or “default”

pub type AnswerGuestQueryParameters {
  AnswerGuestQueryParameters(
    guest_query_id: String,
    text: String,
    parse_mode: option.Option(String),
    entities: option.Option(List(MessageEntity)),
    link_preview_options: option.Option(LinkPreviewOptions),
    reply_markup: option.Option(InlineKeyboardMarkup),
  )
}

Constructors

• AnswerGuestQueryParameters(
    guest_query_id: String,
    text: String,
    parse_mode: option.Option(String),
    entities: option.Option(List(MessageEntity)),
    link_preview_options: option.Option(LinkPreviewOptions),
    reply_markup: option.Option(InlineKeyboardMarkup),
  )

  Arguments

  guest_query_id

  Unique identifier of the guest query as returned in Message.guest_query_id

  text

  Text of the message to be sent, 0-4096 characters

  parse_mode

  Optional. Mode for parsing entities in the message text

  entities

  Optional. A JSON-serialized list of special entities that appear in the message text

  link_preview_options

  Optional. Link preview generation options for the message

  reply_markup

  Optional. Additional interface options. A JSON-serialized object for an inline keyboard

pub type AnswerInlineQueryParameters {
  AnswerInlineQueryParameters(
    inline_query_id: String,
    results: List(InlineQueryResult),
    cache_time: option.Option(Int),
    is_personal: option.Option(Bool),
    next_offset: option.Option(String),
    button: option.Option(InlineQueryResultsButton),
  )
}

Constructors

• AnswerInlineQueryParameters(
    inline_query_id: String,
    results: List(InlineQueryResult),
    cache_time: option.Option(Int),
    is_personal: option.Option(Bool),
    next_offset: option.Option(String),
    button: option.Option(InlineQueryResultsButton),
  )

  Arguments

  inline_query_id

  Unique identifier for the answered query

  results

  A JSON-serialized array of results for the inline query

  cache_time

  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

  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

  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

  A JSON-serialized object describing a button to be shown above inline query results

pub type AnswerPreCheckoutQueryParameters {
  AnswerPreCheckoutQueryParameters(
    pre_checkout_query_id: String,
    ok: Bool,
    error_message: option.Option(String),
  )
}

Constructors

• AnswerPreCheckoutQueryParameters(
    pre_checkout_query_id: String,
    ok: Bool,
    error_message: option.Option(String),
  )

  Arguments

  pre_checkout_query_id

  Unique identifier for the query to be answered

  ok

  Specify True if everything is alright and the bot is ready to proceed with the order. Use False if there are any problems.

  error_message

  Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout

pub type AnswerShippingQueryParameters {
  AnswerShippingQueryParameters(
    shipping_query_id: String,
    ok: Bool,
    shipping_options: option.Option(List(ShippingOption)),
    error_message: option.Option(String),
  )
}

Constructors

• AnswerShippingQueryParameters(
    shipping_query_id: String,
    ok: Bool,
    shipping_options: option.Option(List(ShippingOption)),
    error_message: option.Option(String),
  )

  Arguments

  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

  shipping_options

  Required if ok is True. A JSON-serialized array of available shipping options.

  error_message

  Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order

pub type ApproveChatJoinRequestParameters {
  ApproveChatJoinRequestParameters(
    chat_id: IntOrString,
    user_id: Int,
  )
}

Constructors

• ApproveChatJoinRequestParameters(
    chat_id: IntOrString,
    user_id: Int,
  )

  Arguments

  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

pub type Audio {
  Audio(
    file_id: String,
    file_unique_id: String,
    duration: Int,
    performer: option.Option(String),
    title: option.Option(String),
    file_name: option.Option(String),
    mime_type: option.Option(String),
    file_size: option.Option(Int),
    thumbnail: option.Option(PhotoSize),
  )
}

Constructors

• Audio(
    file_id: String,
    file_unique_id: String,
    duration: Int,
    performer: option.Option(String),
    title: option.Option(String),
    file_name: option.Option(String),
    mime_type: option.Option(String),
    file_size: option.Option(Int),
    thumbnail: option.Option(PhotoSize),
  )

  Arguments

  file_id

  Identifier for this file, which can be used to download or reuse the file

  file_unique_id

  Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

  duration

  Duration of the audio in seconds as defined by the sender

  performer

  Optional. Performer of the audio as defined by the sender or by audio tags

  title

  Optional. Title of the audio as defined by the sender or by audio tags

  file_name

  Optional. Original filename as defined by the sender

  mime_type

  Optional. MIME type of the file as defined by the sender

  file_size

  Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

  thumbnail

  Optional. Thumbnail of the album cover to which the music file belongs

pub type BackgroundFill {
  BackgroundFillSolidBackgroundFill(BackgroundFillSolid)
  BackgroundFillGradientBackgroundFill(BackgroundFillGradient)
  BackgroundFillFreeformGradientBackgroundFill(
    BackgroundFillFreeformGradient,
  )
}

Constructors

• BackgroundFillSolidBackgroundFill(BackgroundFillSolid)

• BackgroundFillGradientBackgroundFill(BackgroundFillGradient)

• BackgroundFillFreeformGradientBackgroundFill(
    BackgroundFillFreeformGradient,
  )

pub type BackgroundFillFreeformGradient {
  BackgroundFillFreeformGradient(
    type_: String,
    colors: List(Int),
  )
}

Constructors

• BackgroundFillFreeformGradient(type_: String, colors: List(Int))

  Arguments

  type_

  Type of the background fill, always “freeform_gradient”

  colors

  A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format

pub type BackgroundFillGradient {
  BackgroundFillGradient(
    type_: String,
    top_color: Int,
    bottom_color: Int,
    rotation_angle: Int,
  )
}

Constructors

• BackgroundFillGradient(
    type_: String,
    top_color: Int,
    bottom_color: Int,
    rotation_angle: Int,
  )

  Arguments

  type_

  Type of the background fill, always “gradient”

  top_color

  Top color of the gradient in the RGB24 format

  bottom_color

  Bottom color of the gradient in the RGB24 format

  rotation_angle

  Clockwise rotation angle of the background fill in degrees; 0-359

pub type BackgroundFillSolid {
  BackgroundFillSolid(type_: String, color: Int)
}

Constructors

• BackgroundFillSolid(type_: String, color: Int)

  Arguments

  type_

  Type of the background fill, always “solid”

  color

  The color of the background fill in the RGB24 format

pub type BackgroundType {
  BackgroundTypeFillBackgroundType(BackgroundTypeFill)
  BackgroundTypeWallpaperBackgroundType(BackgroundTypeWallpaper)
  BackgroundTypePatternBackgroundType(BackgroundTypePattern)
  BackgroundTypeChatThemeBackgroundType(BackgroundTypeChatTheme)
}

Constructors

• BackgroundTypeFillBackgroundType(BackgroundTypeFill)

• BackgroundTypeWallpaperBackgroundType(BackgroundTypeWallpaper)

• BackgroundTypePatternBackgroundType(BackgroundTypePattern)

• BackgroundTypeChatThemeBackgroundType(BackgroundTypeChatTheme)

pub type BackgroundTypeChatTheme {
  BackgroundTypeChatTheme(type_: String, theme_name: String)
}

Constructors

• BackgroundTypeChatTheme(type_: String, theme_name: String)

  Arguments

  type_

  Type of the background, always “chat_theme”

  theme_name

  Name of the chat theme, which is usually an emoji

pub type BackgroundTypeFill {
  BackgroundTypeFill(
    type_: String,
    fill: BackgroundFill,
    dark_theme_dimming: Int,
  )
}

Constructors

• BackgroundTypeFill(
    type_: String,
    fill: BackgroundFill,
    dark_theme_dimming: Int,
  )

  Arguments

  type_

  Type of the background, always “fill”

  fill

  The background fill

  dark_theme_dimming

  Dimming of the background in dark themes, as a percentage; 0-100

pub type BackgroundTypePattern {
  BackgroundTypePattern(
    type_: String,
    document: Document,
    fill: BackgroundFill,
    intensity: Int,
    is_inverted: option.Option(Bool),
    is_moving: option.Option(Bool),
  )
}

Constructors

• BackgroundTypePattern(
    type_: String,
    document: Document,
    fill: BackgroundFill,
    intensity: Int,
    is_inverted: option.Option(Bool),
    is_moving: option.Option(Bool),
  )

  Arguments

  type_

  Type of the background, always “pattern”

  document

  Document with the pattern

  fill

  The background fill that is combined with the pattern

  intensity

  Intensity of the pattern when it is shown above the filled background; 0-100

  is_inverted

  Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only.

  is_moving

  Optional. True, if the background moves slightly when the device is tilted

pub type BackgroundTypeWallpaper {
  BackgroundTypeWallpaper(
    type_: String,
    document: Document,
    dark_theme_dimming: Int,
    is_blurred: option.Option(Bool),
    is_moving: option.Option(Bool),
  )
}

Constructors

• BackgroundTypeWallpaper(
    type_: String,
    document: Document,
    dark_theme_dimming: Int,
    is_blurred: option.Option(Bool),
    is_moving: option.Option(Bool),
  )

  Arguments

  type_

  Type of the background, always “wallpaper”

  document

  Document with the wallpaper

  dark_theme_dimming

  Dimming of the background in dark themes, as a percentage; 0-100

  is_blurred

  Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12

  is_moving

  Optional. True, if the background moves slightly when the device is tilted

pub type BanChatMemberParameters {
  BanChatMemberParameters(
    chat_id: IntOrString,
    user_id: Int,
    until_date: option.Option(Int),
    revoke_messages: option.Option(Bool),
  )
}

Constructors

• BanChatMemberParameters(
    chat_id: IntOrString,
    user_id: Int,
    until_date: option.Option(Int),
    revoke_messages: option.Option(Bool),
  )

  Arguments

  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

  until_date

  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

  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.

pub type BanChatSenderChatParameters {
  BanChatSenderChatParameters(
    chat_id: IntOrString,
    sender_chat_id: Int,
  )
}

Constructors

• BanChatSenderChatParameters(
    chat_id: IntOrString,
    sender_chat_id: Int,
  )

  Arguments

  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

pub type Birthdate {
  Birthdate(day: Int, month: Int, year: option.Option(Int))
}

Constructors

• Birthdate(day: Int, month: Int, year: option.Option(Int))

  Arguments

  day

  Day of the user’s birth; 1-31

  month

  Month of the user’s birth; 1-12

  year

  Optional. Year of the user’s birth

pub type BotAccessSettings {
  BotAccessSettings(
    is_access_restricted: Bool,
    added_users: option.Option(List(User)),
  )
}

Constructors

• BotAccessSettings(
    is_access_restricted: Bool,
    added_users: option.Option(List(User)),
  )

  Arguments

  is_access_restricted

  True, if only selected users can access the bot. The bot’s owner can always access it.

  added_users

  Optional. The list of other users who have access to the bot if the access is restricted

pub type BotCommand {
  BotCommand(
    command: String,
    description: String,
    is_ephemeral: option.Option(Bool),
  )
}

Constructors

• BotCommand(
    command: String,
    description: String,
    is_ephemeral: option.Option(Bool),
  )

  Arguments

  command

  Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.

  description

  Description of the command; 1-256 characters

  is_ephemeral

  Optional. True, if the command sends an ephemeral message, which can be seen only by the sender of the message and the bot

pub type BotCommandParameters {
  BotCommandParameters(
    scope: option.Option(BotCommandScope),
    language_code: option.Option(String),
  )
}

Constructors

• BotCommandParameters(
    scope: option.Option(BotCommandScope),
    language_code: option.Option(String),
  )

  Arguments

  scope

  An object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.

  language_code

  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

pub type BotCommandScope {
  BotCommandScopeDefaultBotCommandScope(BotCommandScopeDefault)
  BotCommandScopeAllPrivateChatsBotCommandScope(
    BotCommandScopeAllPrivateChats,
  )
  BotCommandScopeAllGroupChatsBotCommandScope(
    BotCommandScopeAllGroupChats,
  )
  BotCommandScopeAllChatAdministratorsBotCommandScope(
    BotCommandScopeAllChatAdministrators,
  )
  BotCommandScopeChatBotCommandScope(BotCommandScopeChat)
  BotCommandScopeChatAdministratorsBotCommandScope(
    BotCommandScopeChatAdministrators,
  )
  BotCommandScopeChatMemberBotCommandScope(
    BotCommandScopeChatMember,
  )
}

Constructors

• BotCommandScopeDefaultBotCommandScope(BotCommandScopeDefault)

• BotCommandScopeAllPrivateChatsBotCommandScope(
    BotCommandScopeAllPrivateChats,
  )

• BotCommandScopeAllGroupChatsBotCommandScope(
    BotCommandScopeAllGroupChats,
  )

• BotCommandScopeAllChatAdministratorsBotCommandScope(
    BotCommandScopeAllChatAdministrators,
  )

• BotCommandScopeChatBotCommandScope(BotCommandScopeChat)

• BotCommandScopeChatAdministratorsBotCommandScope(
    BotCommandScopeChatAdministrators,
  )

• BotCommandScopeChatMemberBotCommandScope(
    BotCommandScopeChatMember,
  )

pub type BotCommandScopeAllChatAdministrators {
  BotCommandScopeAllChatAdministrators(type_: String)
}

Constructors

• BotCommandScopeAllChatAdministrators(type_: String)

  Arguments

  type_

  Scope type, must be all_chat_administrators

pub type BotCommandScopeAllGroupChats {
  BotCommandScopeAllGroupChats(type_: String)
}

Constructors

• BotCommandScopeAllGroupChats(type_: String)

  Arguments

  type_

  Scope type, must be all_group_chats

pub type BotCommandScopeAllPrivateChats {
  BotCommandScopeAllPrivateChats(type_: String)
}

Constructors

• BotCommandScopeAllPrivateChats(type_: String)

  Arguments

  type_

  Scope type, must be all_private_chats

pub type BotCommandScopeChat {
  BotCommandScopeChat(type_: String, chat_id: IntOrString)
}

Constructors

• BotCommandScopeChat(type_: String, chat_id: IntOrString)

  Arguments

  type_

  Scope type, must be chat

  chat_id

  Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren’t supported.

pub type BotCommandScopeChatAdministrators {
  BotCommandScopeChatAdministrators(
    type_: String,
    chat_id: IntOrString,
  )
}

Constructors

• BotCommandScopeChatAdministrators(
    type_: String,
    chat_id: IntOrString,
  )

  Arguments

  type_

  Scope type, must be chat_administrators

  chat_id

  Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren’t supported.

pub type BotCommandScopeChatMember {
  BotCommandScopeChatMember(
    type_: String,
    chat_id: IntOrString,
    user_id: Int,
  )
}

Constructors

• BotCommandScopeChatMember(
    type_: String,
    chat_id: IntOrString,
    user_id: Int,
  )

  Arguments

  type_

  Scope type, must be chat_member

  chat_id

  Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren’t supported.

  user_id

  Unique identifier of the target user

pub type BotCommandScopeDefault {
  BotCommandScopeDefault(type_: String)
}

Constructors

• BotCommandScopeDefault(type_: String)

  Arguments

  type_

  Scope type, must be default

pub type BotDescription {
  BotDescription(description: String)
}

Constructors

• BotDescription(description: String)

  Arguments

  description

  The bot’s description

pub type BotName {
  BotName(name: String)
}

Constructors

• BotName(name: String)

  Arguments

  name

  The bot’s name

pub type BotShortDescription {
  BotShortDescription(short_description: String)
}

Constructors

• BotShortDescription(short_description: String)

  Arguments

  short_description

  The bot’s short description

pub type BotSubscriptionUpdated {
  BotSubscriptionUpdated(
    user: User,
    invoice_payload: String,
    state: String,
  )
}

Constructors

• BotSubscriptionUpdated(
    user: User,
    invoice_payload: String,
    state: String,
  )

  Arguments

  user

  User who subscribed for payments toward the bot

  invoice_payload

  Bot-specified invoice payload

  state

  The new state of the subscription. Currently, it can be one of “canceled” if the user canceled the subscription, “active” if the user re-enabled a previously canceled subscription, or “failed” if payment for the subscription failed.

pub type BusinessBotRights {
  BusinessBotRights(
    can_reply: option.Option(Bool),
    can_read_messages: option.Option(Bool),
    can_delete_sent_messages: option.Option(Bool),
    can_delete_all_messages: option.Option(Bool),
    can_edit_name: option.Option(Bool),
    can_edit_bio: option.Option(Bool),
    can_edit_profile_photo: option.Option(Bool),
    can_edit_username: option.Option(Bool),
    can_change_gift_settings: option.Option(Bool),
    can_view_gifts_and_stars: option.Option(Bool),
    can_convert_gifts_to_stars: option.Option(Bool),
    can_transfer_and_upgrade_gifts: option.Option(Bool),
    can_transfer_stars: option.Option(Bool),
    can_manage_stories: option.Option(Bool),
  )
}

Constructors

• BusinessBotRights(
    can_reply: option.Option(Bool),
    can_read_messages: option.Option(Bool),
    can_delete_sent_messages: option.Option(Bool),
    can_delete_all_messages: option.Option(Bool),
    can_edit_name: option.Option(Bool),
    can_edit_bio: option.Option(Bool),
    can_edit_profile_photo: option.Option(Bool),
    can_edit_username: option.Option(Bool),
    can_change_gift_settings: option.Option(Bool),
    can_view_gifts_and_stars: option.Option(Bool),
    can_convert_gifts_to_stars: option.Option(Bool),
    can_transfer_and_upgrade_gifts: option.Option(Bool),
    can_transfer_stars: option.Option(Bool),
    can_manage_stories: option.Option(Bool),
  )

  Arguments

  can_reply

  Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours

  can_read_messages

  Optional. True, if the bot can mark incoming private messages as read

  can_delete_sent_messages

  Optional. True, if the bot can delete messages sent by the bot

  can_delete_all_messages

  Optional. True, if the bot can delete all private messages in managed chats

  can_edit_name

  Optional. True, if the bot can edit the first and last name of the business account

  can_edit_bio

  Optional. True, if the bot can edit the bio of the business account

  can_edit_profile_photo

  Optional. True, if the bot can edit the profile photo of the business account

  can_edit_username

  Optional. True, if the bot can edit the username of the business account

  can_change_gift_settings

  Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account

  can_view_gifts_and_stars

  Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account

  can_convert_gifts_to_stars

  Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars

  can_transfer_and_upgrade_gifts

  Optional. True, if the bot can transfer and upgrade gifts owned by the business account

  can_transfer_stars

  Optional. True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts

  can_manage_stories

  Optional. True, if the bot can post, edit and delete stories on behalf of the business account

pub type BusinessConnection {
  BusinessConnection(
    id: String,
    user: User,
    user_chat_id: Int,
    date: Int,
    rights: option.Option(BusinessBotRights),
    is_enabled: Bool,
  )
}

Constructors

• BusinessConnection(
    id: String,
    user: User,
    user_chat_id: Int,
    date: Int,
    rights: option.Option(BusinessBotRights),
    is_enabled: Bool,
  )

  Arguments

  id

  Unique identifier of the business connection

  user

  Business account user that created the business connection

  user_chat_id

  Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

  date

  Date the connection was established in Unix time

  rights

  Optional. Rights of the business bot

  is_enabled

  True, if the connection is active

pub type BusinessIntro {
  BusinessIntro(
    title: option.Option(String),
    message: option.Option(String),
    sticker: option.Option(Sticker),
  )
}

Constructors

• BusinessIntro(
    title: option.Option(String),
    message: option.Option(String),
    sticker: option.Option(Sticker),
  )

  Arguments

  title

  Optional. Title text of the business intro

  message

  Optional. Message text of the business intro

  sticker

  Optional. Sticker of the business intro

pub type BusinessLocation {
  BusinessLocation(
    address: String,
    location: option.Option(Location),
  )
}

Constructors

• BusinessLocation(
    address: String,
    location: option.Option(Location),
  )

  Arguments

  address

  Address of the business

  location

  Optional. Location of the business

pub type BusinessMessagesDeleted {
  BusinessMessagesDeleted(
    business_connection_id: String,
    chat: Chat,
    message_ids: List(Int),
  )
}

Constructors

• BusinessMessagesDeleted(
    business_connection_id: String,
    chat: Chat,
    message_ids: List(Int),
  )

  Arguments

  business_connection_id

  Unique identifier of the business connection

  chat

  Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.

  message_ids

  The list of identifiers of deleted messages in the chat of the business account

pub type BusinessOpeningHours {
  BusinessOpeningHours(
    time_zone_name: String,
    opening_hours: List(BusinessOpeningHoursInterval),
  )
}

Constructors

• BusinessOpeningHours(
    time_zone_name: String,
    opening_hours: List(BusinessOpeningHoursInterval),
  )

  Arguments

  time_zone_name

  Unique name of the time zone for which the opening hours are defined

  opening_hours

  List of time intervals describing business opening hours

pub type BusinessOpeningHoursInterval {
  BusinessOpeningHoursInterval(
    opening_minute: Int,
    closing_minute: Int,
  )
}

Constructors

• BusinessOpeningHoursInterval(
    opening_minute: Int,
    closing_minute: Int,
  )

  Arguments

  opening_minute

  The minute’s sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60

  closing_minute

  The minute’s sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60

pub type CallbackGame {
  CallbackGame
}

Constructors

• CallbackGame

pub type CallbackQuery {
  CallbackQuery(
    id: String,
    from: User,
    message: option.Option(MaybeInaccessibleMessage),
    inline_message_id: option.Option(String),
    chat_instance: String,
    data: option.Option(String),
    game_short_name: option.Option(String),
  )
}

Constructors

• CallbackQuery(
    id: String,
    from: User,
    message: option.Option(MaybeInaccessibleMessage),
    inline_message_id: option.Option(String),
    chat_instance: String,
    data: option.Option(String),
    game_short_name: option.Option(String),
  )

  Arguments

  id

  Unique identifier for this query

  from

  Sender

  message

  Optional. Message sent by the bot with the callback button that originated the query

  inline_message_id

  Optional. Identifier of the message sent via the bot in inline mode, that originated the query

  chat_instance

  Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.

  data

  Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.

  game_short_name

  Optional. Short name of a Game to be returned, serves as the unique identifier for the game

pub type Chat {
  Chat(
    id: Int,
    type_: String,
    title: option.Option(String),
    username: option.Option(String),
    first_name: option.Option(String),
    last_name: option.Option(String),
    is_forum: option.Option(Bool),
    is_direct_messages: option.Option(Bool),
  )
}

Constructors

• Chat(
    id: Int,
    type_: String,
    title: option.Option(String),
    username: option.Option(String),
    first_name: option.Option(String),
    last_name: option.Option(String),
    is_forum: option.Option(Bool),
    is_direct_messages: option.Option(Bool),
  )

  Arguments

  id

  Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

  type_

  Type of the chat, can be either “private”, “group”, “supergroup” or “channel”

  title

  Optional. Title, for supergroups, channels and group chats

  username

  Optional. Username, for private chats, supergroups and channels if available

  first_name

  Optional. First name of the other party in a private chat

  last_name

  Optional. Last name of the other party in a private chat

  is_forum

  Optional. True, if the supergroup chat is a forum (has topics enabled)

  is_direct_messages

  Optional. True, if the chat is the direct messages chat of a channel

pub type ChatAction {
  Typing
  UploadPhoto
  RecordVideo
  UploadVideo
  RecordVoice
  UploadVoice
  UploadDocument
  ChooseSticker
  FindLocation
  RecordVideoNote
  UploadVideoNote
}

Constructors

• Typing

• UploadPhoto

• RecordVideo

• UploadVideo

• RecordVoice

• UploadVoice

• UploadDocument

• ChooseSticker

• FindLocation

• RecordVideoNote

• UploadVideoNote

pub type ChatAdministratorRights {
  ChatAdministratorRights(
    is_anonymous: Bool,
    can_manage_chat: Bool,
    can_delete_messages: Bool,
    can_manage_video_chats: Bool,
    can_restrict_members: Bool,
    can_promote_members: Bool,
    can_change_info: Bool,
    can_invite_users: Bool,
    can_post_stories: Bool,
    can_edit_stories: Bool,
    can_delete_stories: Bool,
    can_post_messages: option.Option(Bool),
    can_edit_messages: option.Option(Bool),
    can_pin_messages: option.Option(Bool),
    can_manage_topics: option.Option(Bool),
    can_manage_direct_messages: option.Option(Bool),
    can_manage_tags: option.Option(Bool),
  )
}

Constructors

• ChatAdministratorRights(
    is_anonymous: Bool,
    can_manage_chat: Bool,
    can_delete_messages: Bool,
    can_manage_video_chats: Bool,
    can_restrict_members: Bool,
    can_promote_members: Bool,
    can_change_info: Bool,
    can_invite_users: Bool,
    can_post_stories: Bool,
    can_edit_stories: Bool,
    can_delete_stories: Bool,
    can_post_messages: option.Option(Bool),
    can_edit_messages: option.Option(Bool),
    can_pin_messages: option.Option(Bool),
    can_manage_topics: option.Option(Bool),
    can_manage_direct_messages: option.Option(Bool),
    can_manage_tags: option.Option(Bool),
  )

  Arguments

  is_anonymous

  True, if the user’s presence in the chat is hidden

  can_manage_chat

  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

  True, if the administrator can delete messages of other users

  can_manage_video_chats

  True, if the administrator can manage video chats

  can_restrict_members

  True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics

  can_promote_members

  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 the user)

  can_change_info

  True, if the user is allowed to change the chat title, photo and other settings

  can_invite_users

  True, if the user is allowed to invite new users to the chat

  can_post_stories

  True, if the administrator can post stories to the chat

  can_edit_stories

  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

  True, if the administrator can delete stories posted by other users

  can_post_messages

  Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only

  can_edit_messages

  Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only

  can_pin_messages

  Optional. True, if the user is allowed to pin messages; for groups and supergroups only

  can_manage_topics

  Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only

  can_manage_direct_messages

  Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only

  can_manage_tags

  Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted, defaults to the value of can_pin_messages.

pub type ChatBackground {
  ChatBackground(type_: BackgroundType)
}

Constructors

• ChatBackground(type_: BackgroundType)

  Arguments

  type_

  Type of the background

pub type ChatBoost {
  ChatBoost(
    boost_id: String,
    add_date: Int,
    expiration_date: Int,
    source: ChatBoostSource,
  )
}

Constructors

• ChatBoost(
    boost_id: String,
    add_date: Int,
    expiration_date: Int,
    source: ChatBoostSource,
  )

  Arguments

  boost_id

  Unique identifier of the boost

  add_date

  Point in time (Unix timestamp) when the chat was boosted

  expiration_date

  Point in time (Unix timestamp) when the boost will automatically expire, unless the booster’s Telegram Premium subscription is prolonged

  source

  Source of the added boost

pub type ChatBoostAdded {
  ChatBoostAdded(boost_count: Int)
}

Constructors

• ChatBoostAdded(boost_count: Int)

  Arguments

  boost_count

  Number of boosts added by the user

pub type ChatBoostRemoved {
  ChatBoostRemoved(
    chat: Chat,
    boost_id: String,
    remove_date: Int,
    source: ChatBoostSource,
  )
}

Constructors

• ChatBoostRemoved(
    chat: Chat,
    boost_id: String,
    remove_date: Int,
    source: ChatBoostSource,
  )

  Arguments

  chat

  Chat which was boosted

  boost_id

  Unique identifier of the boost

  remove_date

  Point in time (Unix timestamp) when the boost was removed

  source

  Source of the removed boost

pub type ChatBoostSource {
  ChatBoostSourcePremiumChatBoostSource(ChatBoostSourcePremium)
  ChatBoostSourceGiftCodeChatBoostSource(ChatBoostSourceGiftCode)
  ChatBoostSourceGiveawayChatBoostSource(ChatBoostSourceGiveaway)
}

Constructors

• ChatBoostSourcePremiumChatBoostSource(ChatBoostSourcePremium)

• ChatBoostSourceGiftCodeChatBoostSource(ChatBoostSourceGiftCode)

• ChatBoostSourceGiveawayChatBoostSource(ChatBoostSourceGiveaway)

pub type ChatBoostSourceGiftCode {
  ChatBoostSourceGiftCode(source: String, user: User)
}

Constructors

• ChatBoostSourceGiftCode(source: String, user: User)

  Arguments

  source

  Source of the boost, always “gift_code”

  user

  User for which the gift code was created

pub type ChatBoostSourceGiveaway {
  ChatBoostSourceGiveaway(
    source: String,
    giveaway_message_id: Int,
    user: option.Option(User),
    prize_star_count: option.Option(Int),
    is_unclaimed: option.Option(Bool),
  )
}

Constructors

• ChatBoostSourceGiveaway(
    source: String,
    giveaway_message_id: Int,
    user: option.Option(User),
    prize_star_count: option.Option(Int),
    is_unclaimed: option.Option(Bool),
  )

  Arguments

  source

  Source of the boost, always “giveaway”

  giveaway_message_id

  Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn’t sent yet.

  user

  Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only

  prize_star_count

  Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only

  is_unclaimed

  Optional. True, if the giveaway was completed, but there was no user to win the prize

pub type ChatBoostSourcePremium {
  ChatBoostSourcePremium(source: String, user: User)
}

Constructors

• ChatBoostSourcePremium(source: String, user: User)

  Arguments

  source

  Source of the boost, always “premium”

  user

  User that boosted the chat

pub type ChatBoostUpdated {
  ChatBoostUpdated(chat: Chat, boost: ChatBoost)
}

Constructors

• ChatBoostUpdated(chat: Chat, boost: ChatBoost)

  Arguments

  chat

  Chat which was boosted

  boost

  Information about the chat boost

pub type ChatFullInfo {
  ChatFullInfo(
    id: Int,
    type_: String,
    title: option.Option(String),
    username: option.Option(String),
    first_name: option.Option(String),
    last_name: option.Option(String),
    is_forum: option.Option(Bool),
    is_direct_messages: option.Option(Bool),
    accent_color_id: Int,
    max_reaction_count: Int,
    photo: option.Option(ChatPhoto),
    active_usernames: option.Option(List(String)),
    birthdate: option.Option(Birthdate),
    business_intro: option.Option(BusinessIntro),
    business_location: option.Option(BusinessLocation),
    business_opening_hours: option.Option(BusinessOpeningHours),
    personal_chat: option.Option(Chat),
    parent_chat: option.Option(Chat),
    available_reactions: option.Option(List(ReactionType)),
    background_custom_emoji_id: option.Option(String),
    profile_accent_color_id: option.Option(Int),
    profile_background_custom_emoji_id: option.Option(String),
    emoji_status_custom_emoji_id: option.Option(String),
    emoji_status_expiration_date: option.Option(Int),
    bio: option.Option(String),
    has_private_forwards: option.Option(Bool),
    has_restricted_voice_and_video_messages: option.Option(Bool),
    join_to_send_messages: option.Option(Bool),
    join_by_request: option.Option(Bool),
    description: option.Option(String),
    invite_link: option.Option(String),
    pinned_message: option.Option(Message),
    permissions: option.Option(ChatPermissions),
    accepted_gift_types: AcceptedGiftTypes,
    can_send_paid_media: option.Option(Bool),
    slow_mode_delay: option.Option(Int),
    unrestrict_boost_count: option.Option(Int),
    message_auto_delete_time: option.Option(Int),
    has_aggressive_anti_spam_enabled: option.Option(Bool),
    has_hidden_members: option.Option(Bool),
    has_protected_content: option.Option(Bool),
    has_visible_history: option.Option(Bool),
    sticker_set_name: option.Option(String),
    can_set_sticker_set: option.Option(Bool),
    custom_emoji_sticker_set_name: option.Option(String),
    linked_chat_id: option.Option(Int),
    location: option.Option(ChatLocation),
    rating: option.Option(UserRating),
    first_profile_audio: option.Option(Audio),
    unique_gift_colors: option.Option(UniqueGiftColors),
    paid_message_star_count: option.Option(Int),
    guard_bot: option.Option(User),
    community: option.Option(Community),
  )
}

Constructors

• ChatFullInfo(
    id: Int,
    type_: String,
    title: option.Option(String),
    username: option.Option(String),
    first_name: option.Option(String),
    last_name: option.Option(String),
    is_forum: option.Option(Bool),
    is_direct_messages: option.Option(Bool),
    accent_color_id: Int,
    max_reaction_count: Int,
    photo: option.Option(ChatPhoto),
    active_usernames: option.Option(List(String)),
    birthdate: option.Option(Birthdate),
    business_intro: option.Option(BusinessIntro),
    business_location: option.Option(BusinessLocation),
    business_opening_hours: option.Option(BusinessOpeningHours),
    personal_chat: option.Option(Chat),
    parent_chat: option.Option(Chat),
    available_reactions: option.Option(List(ReactionType)),
    background_custom_emoji_id: option.Option(String),
    profile_accent_color_id: option.Option(Int),
    profile_background_custom_emoji_id: option.Option(String),
    emoji_status_custom_emoji_id: option.Option(String),
    emoji_status_expiration_date: option.Option(Int),
    bio: option.Option(String),
    has_private_forwards: option.Option(Bool),
    has_restricted_voice_and_video_messages: option.Option(Bool),
    join_to_send_messages: option.Option(Bool),
    join_by_request: option.Option(Bool),
    description: option.Option(String),
    invite_link: option.Option(String),
    pinned_message: option.Option(Message),
    permissions: option.Option(ChatPermissions),
    accepted_gift_types: AcceptedGiftTypes,
    can_send_paid_media: option.Option(Bool),
    slow_mode_delay: option.Option(Int),
    unrestrict_boost_count: option.Option(Int),
    message_auto_delete_time: option.Option(Int),
    has_aggressive_anti_spam_enabled: option.Option(Bool),
    has_hidden_members: option.Option(Bool),
    has_protected_content: option.Option(Bool),
    has_visible_history: option.Option(Bool),
    sticker_set_name: option.Option(String),
    can_set_sticker_set: option.Option(Bool),
    custom_emoji_sticker_set_name: option.Option(String),
    linked_chat_id: option.Option(Int),
    location: option.Option(ChatLocation),
    rating: option.Option(UserRating),
    first_profile_audio: option.Option(Audio),
    unique_gift_colors: option.Option(UniqueGiftColors),
    paid_message_star_count: option.Option(Int),
    guard_bot: option.Option(User),
    community: option.Option(Community),
  )

  Arguments

  id

  Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

  type_

  Type of the chat, can be either “private”, “group”, “supergroup” or “channel”

  title

  Optional. Title, for supergroups, channels and group chats

  username

  Optional. Username, for private chats, supergroups and channels if available

  first_name

  Optional. First name of the other party in a private chat

  last_name

  Optional. Last name of the other party in a private chat

  is_forum

  Optional. True, if the supergroup chat is a forum (has topics enabled)

  is_direct_messages

  Optional. True, if the chat is the direct messages chat of a channel

  accent_color_id

  Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.

  max_reaction_count

  The maximum number of reactions that can be set on a message in the chat

  photo

  Optional. Chat photo

  active_usernames

  Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels

  birthdate

  Optional. For private chats, the date of birth of the user

  business_intro

  Optional. For private chats with business accounts, the intro of the business

  business_location

  Optional. For private chats with business accounts, the location of the business

  business_opening_hours

  Optional. For private chats with business accounts, the opening hours of the business

  personal_chat

  Optional. For private chats, the personal channel of the user

  parent_chat

  Optional. Information about the corresponding channel chat; for direct messages chats only

  available_reactions

  Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.

  background_custom_emoji_id

  Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background

  profile_accent_color_id

  Optional. Identifier of the accent color for the chat’s profile background. See profile accent colors for more details.

  profile_background_custom_emoji_id

  Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background

  emoji_status_custom_emoji_id

  Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat

  emoji_status_expiration_date

  Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any

  bio

  Optional. Bio of the other party in a private chat

  has_private_forwards

  Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user

  has_restricted_voice_and_video_messages

  Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat

  join_to_send_messages

  Optional. True, if users need to join the supergroup before they can send messages

  join_by_request

  Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators

  description

  Optional. Description, for groups, supergroups and channel chats

  invite_link

  Optional. Primary invite link, for groups, supergroups and channel chats

  pinned_message

  Optional. The most recent pinned message (by sending date)

  permissions

  Optional. Default chat member permissions, for groups and supergroups

  accepted_gift_types

  Information about types of gifts that are accepted by the chat or by the corresponding user for private chats

  can_send_paid_media

  Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.

  slow_mode_delay

  Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds

  unrestrict_boost_count

  Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions

  message_auto_delete_time

  Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds

  has_aggressive_anti_spam_enabled

  Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.

  has_hidden_members

  Optional. True, if non-administrators can only get the list of bots and administrators in the chat

  has_protected_content

  Optional. True, if messages from the chat can’t be forwarded to other chats

  has_visible_history

  Optional. True, if new chat members will have access to old messages; available only to chat administrators

  sticker_set_name

  Optional. For supergroups, name of the group sticker set

  can_set_sticker_set

  Optional. True, if the bot can change the group sticker set

  custom_emoji_sticker_set_name

  Optional. For supergroups, the name of the group’s custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.

  linked_chat_id

  Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

  location

  Optional. For supergroups, the location to which the supergroup is connected

  rating

  Optional. For private chats, the rating of the user if any

  first_profile_audio

  Optional. For private chats, the first audio added to the profile of the user

  unique_gift_colors

  Optional. The color scheme based on a unique gift that must be used for the chat’s name, message replies and link previews

  paid_message_star_count

  Optional. The number of Telegram Stars a general user has to pay to send a message to the chat

  guard_bot

  Optional. The bot that processes join request queries in the chat. The field is only available to chat administrators.

  community

  Optional. The Community to which the chat belongs

pub type ChatInviteLink {
  ChatInviteLink(
    invite_link: String,
    creator: User,
    creates_join_request: Bool,
    is_primary: Bool,
    is_revoked: Bool,
    name: option.Option(String),
    expire_date: option.Option(Int),
    member_limit: option.Option(Int),
    pending_join_request_count: option.Option(Int),
    subscription_period: option.Option(Int),
    subscription_price: option.Option(Int),
  )
}

Constructors

• ChatInviteLink(
    invite_link: String,
    creator: User,
    creates_join_request: Bool,
    is_primary: Bool,
    is_revoked: Bool,
    name: option.Option(String),
    expire_date: option.Option(Int),
    member_limit: option.Option(Int),
    pending_join_request_count: option.Option(Int),
    subscription_period: option.Option(Int),
    subscription_price: option.Option(Int),
  )

  Arguments

  invite_link

  The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.

  creator

  Creator of the link

  creates_join_request

  True, if users joining the chat via the link need to be approved by chat administrators

  is_primary

  True, if the link is primary

  is_revoked

  True, if the link is revoked

  name

  Optional. Invite link name

  expire_date

  Optional. Point in time (Unix timestamp) when the link will expire or has been expired

  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

  pending_join_request_count

  Optional. Number of pending join requests created using this link

  subscription_period

  Optional. The number of seconds the subscription will be active for before the next payment

  subscription_price

  Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link

pub type ChatJoinRequest {
  ChatJoinRequest(
    chat: Chat,
    from: User,
    user_chat_id: Int,
    date: Int,
    bio: option.Option(String),
    invite_link: option.Option(ChatInviteLink),
    query_id: option.Option(String),
  )
}

Constructors

• ChatJoinRequest(
    chat: Chat,
    from: User,
    user_chat_id: Int,
    date: Int,
    bio: option.Option(String),
    invite_link: option.Option(ChatInviteLink),
    query_id: option.Option(String),
  )

  Arguments

  chat

  Chat to which the request was sent

  from

  User that sent the join request

  user_chat_id

  Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.

  date

  Date the request was sent in Unix time

  bio

  Optional. Bio of the user

  invite_link

  Optional. Chat invite link that was used by the user to send the join request

  query_id

  Optional. Identifier of the join request query; for bots assigned to process join requests only. If present, then the bot must call sendChatJoinRequestWebApp or directly call answerChatJoinRequestQuery within 10 seconds.

pub type ChatLocation {
  ChatLocation(location: Location, address: String)
}

Constructors

• ChatLocation(location: Location, address: String)

  Arguments

  location

  The location to which the supergroup is connected. Can’t be a live location.

  address

  Location address; 1-64 characters, as defined by the chat owner

pub type ChatMember {
  ChatMemberOwnerChatMember(ChatMemberOwner)
  ChatMemberAdministratorChatMember(ChatMemberAdministrator)
  ChatMemberMemberChatMember(ChatMemberMember)
  ChatMemberRestrictedChatMember(ChatMemberRestricted)
  ChatMemberLeftChatMember(ChatMemberLeft)
  ChatMemberBannedChatMember(ChatMemberBanned)
}

Constructors

• ChatMemberOwnerChatMember(ChatMemberOwner)

• ChatMemberAdministratorChatMember(ChatMemberAdministrator)

• ChatMemberMemberChatMember(ChatMemberMember)

• ChatMemberRestrictedChatMember(ChatMemberRestricted)

• ChatMemberLeftChatMember(ChatMemberLeft)

• ChatMemberBannedChatMember(ChatMemberBanned)

pub type ChatMemberAdministrator {
  ChatMemberAdministrator(
    status: String,
    user: User,
    can_be_edited: Bool,
    is_anonymous: Bool,
    can_manage_chat: Bool,
    can_delete_messages: Bool,
    can_manage_video_chats: Bool,
    can_restrict_members: Bool,
    can_promote_members: Bool,
    can_change_info: Bool,
    can_invite_users: Bool,
    can_post_stories: Bool,
    can_edit_stories: Bool,
    can_delete_stories: Bool,
    can_post_messages: option.Option(Bool),
    can_edit_messages: option.Option(Bool),
    can_pin_messages: option.Option(Bool),
    can_manage_topics: option.Option(Bool),
    can_manage_direct_messages: option.Option(Bool),
    can_manage_tags: option.Option(Bool),
    custom_title: option.Option(String),
  )
}

Constructors

• ChatMemberAdministrator(
    status: String,
    user: User,
    can_be_edited: Bool,
    is_anonymous: Bool,
    can_manage_chat: Bool,
    can_delete_messages: Bool,
    can_manage_video_chats: Bool,
    can_restrict_members: Bool,
    can_promote_members: Bool,
    can_change_info: Bool,
    can_invite_users: Bool,
    can_post_stories: Bool,
    can_edit_stories: Bool,
    can_delete_stories: Bool,
    can_post_messages: option.Option(Bool),
    can_edit_messages: option.Option(Bool),
    can_pin_messages: option.Option(Bool),
    can_manage_topics: option.Option(Bool),
    can_manage_direct_messages: option.Option(Bool),
    can_manage_tags: option.Option(Bool),
    custom_title: option.Option(String),
  )

  Arguments

  status

  The member’s status in the chat, always “administrator”

  user

  Information about the user

  can_be_edited

  True, if the bot is allowed to edit administrator privileges of that user

  is_anonymous

  True, if the user’s presence in the chat is hidden

  can_manage_chat

  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

  True, if the administrator can delete messages of other users

  can_manage_video_chats

  True, if the administrator can manage video chats

  can_restrict_members

  True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics

  can_promote_members

  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 the user)

  can_change_info

  True, if the user is allowed to change the chat title, photo and other settings

  can_invite_users

  True, if the user is allowed to invite new users to the chat

  can_post_stories

  True, if the administrator can post stories to the chat

  can_edit_stories

  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

  True, if the administrator can delete stories posted by other users

  can_post_messages

  Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only

  can_edit_messages

  Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only

  can_pin_messages

  Optional. True, if the user is allowed to pin messages; for groups and supergroups only

  can_manage_topics

  Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only

  can_manage_direct_messages

  Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only

  can_manage_tags

  Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted, defaults to the value of can_pin_messages.

  custom_title

  Optional. Custom title for this user

pub type ChatMemberBanned {
  ChatMemberBanned(status: String, user: User, until_date: Int)
}

Constructors

• ChatMemberBanned(status: String, user: User, until_date: Int)

  Arguments

  status

  The member’s status in the chat, always “kicked”

  user

  Information about the user

  until_date

  Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever.

pub type ChatMemberLeft {
  ChatMemberLeft(status: String, user: User)
}

Constructors

• ChatMemberLeft(status: String, user: User)

  Arguments

  status

  The member’s status in the chat, always “left”

  user

  Information about the user

pub type ChatMemberMember {
  ChatMemberMember(
    status: String,
    tag: option.Option(String),
    user: User,
    until_date: option.Option(Int),
  )
}

Constructors

• ChatMemberMember(
    status: String,
    tag: option.Option(String),
    user: User,
    until_date: option.Option(Int),
  )

  Arguments

  status

  The member’s status in the chat, always “member”

  tag

  Optional. Tag of the member

  user

  Information about the user

  until_date

  Optional. Date when the user’s subscription will expire; Unix time

pub type ChatMemberOwner {
  ChatMemberOwner(
    status: String,
    user: User,
    is_anonymous: Bool,
    custom_title: option.Option(String),
  )
}

Constructors

• ChatMemberOwner(
    status: String,
    user: User,
    is_anonymous: Bool,
    custom_title: option.Option(String),
  )

  Arguments

  status

  The member’s status in the chat, always “creator”

  user

  Information about the user

  is_anonymous

  True, if the user’s presence in the chat is hidden

  custom_title

  Optional. Custom title for this user

pub type ChatMemberRestricted {
  ChatMemberRestricted(
    status: String,
    tag: option.Option(String),
    user: User,
    is_member: Bool,
    can_send_messages: Bool,
    can_send_audios: Bool,
    can_send_documents: Bool,
    can_send_photos: Bool,
    can_send_videos: Bool,
    can_send_video_notes: Bool,
    can_send_voice_notes: Bool,
    can_send_polls: Bool,
    can_send_other_messages: Bool,
    can_add_web_page_previews: Bool,
    can_react_to_messages: Bool,
    can_edit_tag: Bool,
    can_change_info: Bool,
    can_invite_users: Bool,
    can_pin_messages: Bool,
    can_manage_topics: Bool,
    until_date: Int,
  )
}

Constructors

• ChatMemberRestricted(
    status: String,
    tag: option.Option(String),
    user: User,
    is_member: Bool,
    can_send_messages: Bool,
    can_send_audios: Bool,
    can_send_documents: Bool,
    can_send_photos: Bool,
    can_send_videos: Bool,
    can_send_video_notes: Bool,
    can_send_voice_notes: Bool,
    can_send_polls: Bool,
    can_send_other_messages: Bool,
    can_add_web_page_previews: Bool,
    can_react_to_messages: Bool,
    can_edit_tag: Bool,
    can_change_info: Bool,
    can_invite_users: Bool,
    can_pin_messages: Bool,
    can_manage_topics: Bool,
    until_date: Int,
  )

  Arguments

  status

  The member’s status in the chat, always “restricted”

  tag

  Optional. Tag of the member

  user

  Information about the user

  is_member

  True, if the user is a member of the chat at the moment of the request

  can_send_messages

  True, if the user is allowed to send text messages, rich messages, contacts, giveaways, giveaway winners, invoices, locations and venues

  can_send_audios

  True, if the user is allowed to send audios

  can_send_documents

  True, if the user is allowed to send documents

  can_send_photos

  True, if the user is allowed to send photos

  can_send_videos

  True, if the user is allowed to send videos

  can_send_video_notes

  True, if the user is allowed to send video notes

  can_send_voice_notes

  True, if the user is allowed to send voice notes

  can_send_polls

  True, if the user is allowed to send polls and checklists

  can_send_other_messages

  True, if the user is allowed to send animations, games, stickers and use inline bots

  can_add_web_page_previews

  True, if the user is allowed to add web page previews to their messages

  can_react_to_messages

  True, if the user is allowed to react to messages

  can_edit_tag

  True, if the user is allowed to edit their own tag

  can_change_info

  True, if the user is allowed to change the chat title, photo and other settings

  can_invite_users

  True, if the user is allowed to invite new users to the chat

  can_pin_messages

  True, if the user is allowed to pin messages

  can_manage_topics

  True, if the user is allowed to create forum topics

  until_date

  Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever.

pub type ChatMemberUpdated {
  ChatMemberUpdated(
    chat: Chat,
    from: User,
    date: Int,
    old_chat_member: ChatMember,
    new_chat_member: ChatMember,
    invite_link: option.Option(ChatInviteLink),
    via_join_request: option.Option(Bool),
    via_chat_folder_invite_link: option.Option(Bool),
  )
}

Constructors

• ChatMemberUpdated(
    chat: Chat,
    from: User,
    date: Int,
    old_chat_member: ChatMember,
    new_chat_member: ChatMember,
    invite_link: option.Option(ChatInviteLink),
    via_join_request: option.Option(Bool),
    via_chat_folder_invite_link: option.Option(Bool),
  )

  Arguments

  chat

  Chat the user belongs to

  from

  Performer of the action, which resulted in the change

  date

  Date the change was done in Unix time

  old_chat_member

  Previous information about the chat member

  new_chat_member

  New information about the chat member

  invite_link

  Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only

  via_join_request

  Optional. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator

  via_chat_folder_invite_link

  Optional. True, if the user joined the chat via a chat folder invite link

pub type ChatOwnerChanged {
  ChatOwnerChanged(new_owner: User)
}

Constructors

• ChatOwnerChanged(new_owner: User)

  Arguments

  new_owner

  The new owner of the chat

pub type ChatOwnerLeft {
  ChatOwnerLeft(new_owner: option.Option(User))
}

Constructors

• ChatOwnerLeft(new_owner: option.Option(User))

  Arguments

  new_owner

  Optional. The user who will become the new owner of the chat if the previous owner does not return to the chat

pub type ChatPermissions {
  ChatPermissions(
    can_send_messages: option.Option(Bool),
    can_send_audios: option.Option(Bool),
    can_send_documents: option.Option(Bool),
    can_send_photos: option.Option(Bool),
    can_send_videos: option.Option(Bool),
    can_send_video_notes: option.Option(Bool),
    can_send_voice_notes: option.Option(Bool),
    can_send_polls: option.Option(Bool),
    can_send_other_messages: option.Option(Bool),
    can_add_web_page_previews: option.Option(Bool),
    can_react_to_messages: option.Option(Bool),
    can_edit_tag: option.Option(Bool),
    can_change_info: option.Option(Bool),
    can_invite_users: option.Option(Bool),
    can_pin_messages: option.Option(Bool),
    can_manage_topics: option.Option(Bool),
  )
}

Constructors

• ChatPermissions(
    can_send_messages: option.Option(Bool),
    can_send_audios: option.Option(Bool),
    can_send_documents: option.Option(Bool),
    can_send_photos: option.Option(Bool),
    can_send_videos: option.Option(Bool),
    can_send_video_notes: option.Option(Bool),
    can_send_voice_notes: option.Option(Bool),
    can_send_polls: option.Option(Bool),
    can_send_other_messages: option.Option(Bool),
    can_add_web_page_previews: option.Option(Bool),
    can_react_to_messages: option.Option(Bool),
    can_edit_tag: option.Option(Bool),
    can_change_info: option.Option(Bool),
    can_invite_users: option.Option(Bool),
    can_pin_messages: option.Option(Bool),
    can_manage_topics: option.Option(Bool),
  )

  Arguments

  can_send_messages

  Optional. True, if the user is allowed to send text messages, rich messages, contacts, giveaways, giveaway winners, invoices, locations and venues

  can_send_audios

  Optional. True, if the user is allowed to send audios

  can_send_documents

  Optional. True, if the user is allowed to send documents

  can_send_photos

  Optional. True, if the user is allowed to send photos

  can_send_videos

  Optional. True, if the user is allowed to send videos

  can_send_video_notes

  Optional. True, if the user is allowed to send video notes

  can_send_voice_notes

  Optional. True, if the user is allowed to send voice notes

  can_send_polls

  Optional. True, if the user is allowed to send polls and checklists

  can_send_other_messages

  Optional. True, if the user is allowed to send animations, games, stickers and use inline bots

  can_add_web_page_previews

  Optional. True, if the user is allowed to add web page previews to their messages

  can_react_to_messages

  Optional. True, if the user is allowed to react to messages. If omitted, defaults to the value of can_send_messages.

  can_edit_tag

  Optional. True, if the user is allowed to edit their own tag. If omitted, defaults to the value of can_pin_messages.

  can_change_info

  Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups.

  can_invite_users

  Optional. True, if the user is allowed to invite new users to the chat

  can_pin_messages

  Optional. True, if the user is allowed to pin messages. Ignored in public supergroups.

  can_manage_topics

  Optional. True, if the user is allowed to create forum topics. If omitted, defaults to the value of can_pin_messages.

pub type ChatPhoto {
  ChatPhoto(
    small_file_id: String,
    small_file_unique_id: String,
    big_file_id: String,
    big_file_unique_id: String,
  )
}

Constructors

• ChatPhoto(
    small_file_id: String,
    small_file_unique_id: String,
    big_file_id: String,
    big_file_unique_id: String,
  )

  Arguments

  small_file_id

  File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.

  small_file_unique_id

  Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

  big_file_id

  File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.

  big_file_unique_id

  Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

pub type ChatShared {
  ChatShared(
    request_id: Int,
    chat_id: Int,
    title: option.Option(String),
    username: option.Option(String),
    photo: option.Option(List(PhotoSize)),
  )
}

Constructors

• ChatShared(
    request_id: Int,
    chat_id: Int,
    title: option.Option(String),
    username: option.Option(String),
    photo: option.Option(List(PhotoSize)),
  )

  Arguments

  request_id

  Identifier of the request

  chat_id

  Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.

  title

  Optional. Title of the chat, if the title was requested by the bot

  username

  Optional. Username of the chat, if the username was requested by the bot and available

  photo

  Optional. Available sizes of the chat photo, if the photo was requested by the bot

pub type Checklist {
  Checklist(
    title: String,
    title_entities: option.Option(List(MessageEntity)),
    tasks: List(ChecklistTask),
    others_can_add_tasks: option.Option(Bool),
    others_can_mark_tasks_as_done: option.Option(Bool),
  )
}

Constructors

• Checklist(
    title: String,
    title_entities: option.Option(List(MessageEntity)),
    tasks: List(ChecklistTask),
    others_can_add_tasks: option.Option(Bool),
    others_can_mark_tasks_as_done: option.Option(Bool),
  )

  Arguments

  title

  Title of the checklist

  title_entities

  Optional. Special entities that appear in the checklist title

  tasks

  List of tasks in the checklist

  others_can_add_tasks

  Optional. True, if users other than the creator of the list can add tasks to the list

  others_can_mark_tasks_as_done

  Optional. True, if users other than the creator of the list can mark tasks as done or not done

pub type ChecklistTask {
  ChecklistTask(
    id: Int,
    text: String,
    text_entities: option.Option(List(MessageEntity)),
    completed_by_user: option.Option(User),
    completed_by_chat: option.Option(Chat),
    completion_date: option.Option(Int),
  )
}

Constructors

• ChecklistTask(
    id: Int,
    text: String,
    text_entities: option.Option(List(MessageEntity)),
    completed_by_user: option.Option(User),
    completed_by_chat: option.Option(Chat),
    completion_date: option.Option(Int),
  )

  Arguments

  id

  Unique identifier of the task

  text

  Text of the task

  text_entities

  Optional. Special entities that appear in the task text

  completed_by_user

  Optional. User that completed the task; omitted if the task wasn’t completed by a user

  completed_by_chat

  Optional. Chat that completed the task; omitted if the task wasn’t completed by a chat

  completion_date

  Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn’t completed

pub type ChecklistTasksAdded {
  ChecklistTasksAdded(
    checklist_message: option.Option(Message),
    tasks: List(ChecklistTask),
  )
}

Constructors

• ChecklistTasksAdded(
    checklist_message: option.Option(Message),
    tasks: List(ChecklistTask),
  )

  Arguments

  checklist_message

  Optional. Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.

  tasks

  List of tasks added to the checklist

pub type ChecklistTasksDone {
  ChecklistTasksDone(
    checklist_message: option.Option(Message),
    marked_as_done_task_ids: option.Option(List(Int)),
    marked_as_not_done_task_ids: option.Option(List(Int)),
  )
}

Constructors

• ChecklistTasksDone(
    checklist_message: option.Option(Message),
    marked_as_done_task_ids: option.Option(List(Int)),
    marked_as_not_done_task_ids: option.Option(List(Int)),
  )

  Arguments

  checklist_message

  Optional. Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.

  marked_as_done_task_ids

  Optional. Identifiers of the tasks that were marked as done

  marked_as_not_done_task_ids

  Optional. Identifiers of the tasks that were marked as not done

pub type ChosenInlineResult {
  ChosenInlineResult(
    result_id: String,
    from: User,
    location: option.Option(Location),
    inline_message_id: option.Option(String),
    query: String,
  )
}

Constructors

• ChosenInlineResult(
    result_id: String,
    from: User,
    location: option.Option(Location),
    inline_message_id: option.Option(String),
    query: String,
  )

  Arguments

  result_id

  The unique identifier for the result that was chosen

  from

  The user that chose the result

  location

  Optional. Sender location, only for bots that require user location

  inline_message_id

  Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.

  query

  The query that was used to obtain the result

pub type CloseForumTopicParameters {
  CloseForumTopicParameters(
    chat_id: IntOrString,
    message_thread_id: Int,
  )
}

Constructors

• CloseForumTopicParameters(
    chat_id: IntOrString,
    message_thread_id: Int,
  )

  Arguments

  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

pub type CloseGeneralForumTopicParameters {
  CloseGeneralForumTopicParameters(chat_id: IntOrString)
}

Constructors

• CloseGeneralForumTopicParameters(chat_id: IntOrString)

  Arguments

  chat_id

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

pub type Community {
  Community(id: Int, name: String)
}

Constructors

• Community(id: Int, name: String)

  Arguments

  id

  Unique identifier for this community. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

  name

  Name of the community

pub type CommunityChatAdded {
  CommunityChatAdded(community: Community)
}

Constructors

• CommunityChatAdded(community: Community)

  Arguments

  community

  The new community to which the chat belongs

pub type CommunityChatRemoved {
  CommunityChatRemoved
}

Constructors

• CommunityChatRemoved

pub type Contact {
  Contact(
    phone_number: String,
    first_name: String,
    last_name: option.Option(String),
    user_id: option.Option(Int),
    vcard: option.Option(String),
  )
}

Constructors

• Contact(
    phone_number: String,
    first_name: String,
    last_name: option.Option(String),
    user_id: option.Option(Int),
    vcard: option.Option(String),
  )

  Arguments

  phone_number

  Contact’s phone number

  first_name

  Contact’s first name

  last_name

  Optional. Contact’s last name

  user_id

  Optional. Contact’s user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

  vcard

  Optional. Additional data about the contact in the form of a vCard

pub type ConvertGiftToStarsParameters {
  ConvertGiftToStarsParameters(
    business_connection_id: String,
    owned_gift_id: String,
  )
}

Constructors

• ConvertGiftToStarsParameters(
    business_connection_id: String,
    owned_gift_id: String,
  )

  Arguments

  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

pub type CopyMessageParameters {
  CopyMessageParameters(
    chat_id: IntOrString,
    message_thread_id: option.Option(Int),
    from_chat_id: IntOrString,
    message_id: Int,
    video_start_timestamp: option.Option(Int),
    caption: option.Option(String),
    parse_mode: option.Option(String),
    caption_entities: option.Option(List(MessageEntity)),
    show_caption_above_media: option.Option(Bool),
    disable_notification: option.Option(Bool),
    protect_content: option.Option(Bool),
    allow_paid_broadcast: option.Option(Bool),
    reply_parameters: option.Option(ReplyParameters),
    reply_markup: option.Option(SendMessageReplyMarkupParameters),
  )
}

Constructors

• CopyMessageParameters(
    chat_id: IntOrString,
    message_thread_id: option.Option(Int),
    from_chat_id: IntOrString,
    message_id: Int,
    video_start_timestamp: option.Option(Int),
    caption: option.Option(String),
    parse_mode: option.Option(String),
    caption_entities: option.Option(List(MessageEntity)),
    show_caption_above_media: option.Option(Bool),
    disable_notification: option.Option(Bool),
    protect_content: option.Option(Bool),
    allow_paid_broadcast: option.Option(Bool),
    reply_parameters: option.Option(ReplyParameters),
    reply_markup: option.Option(SendMessageReplyMarkupParameters),
  )

  Arguments

  chat_id

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

  message_thread_id

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

  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

  video_start_timestamp

  New start timestamp for the copied video in the message

  caption

  New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept

  parse_mode

  Mode for parsing entities in the new caption. See formatting options for more details.

  caption_entities

  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

  Pass True, if the caption must be shown above the message media. Ignored if a new caption isn’t specified.

  disable_notification

  Sends the message silently. Users will receive a notification with no sound.

  protect_content

  Protects the contents of the sent message from forwarding and saving

  allow_paid_broadcast

  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

  reply_parameters

  Description of the message to reply to

  reply_markup

  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

pub type CopyMessagesParameters {
  CopyMessagesParameters(
    chat_id: IntOrString,
    message_thread_id: option.Option(Int),
    from_chat_id: IntOrString,
    message_ids: List(Int),
    disable_notification: option.Option(Bool),
    protect_content: option.Option(Bool),
    remove_caption: option.Option(Bool),
  )
}

Constructors

• CopyMessagesParameters(
    chat_id: IntOrString,
    message_thread_id: option.Option(Int),
    from_chat_id: IntOrString,
    message_ids: List(Int),
    disable_notification: option.Option(Bool),
    protect_content: option.Option(Bool),
    remove_caption: option.Option(Bool),
  )

  Arguments

  chat_id

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

  message_thread_id

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

  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

  disable_notification

  Sends the messages silently. Users will receive a notification with no sound.

  protect_content

  Protects the contents of the sent messages from forwarding and saving

  remove_caption

  Pass True to copy the messages without their captions

pub type CopyTextButton {
  CopyTextButton(text: String)
}

Constructors

• CopyTextButton(text: String)

  Arguments

  text

  The text to be copied to the clipboard; 1-256 characters

pub type CreateChatInviteLinkParameters {
  CreateChatInviteLinkParameters(
    chat_id: IntOrString,
    name: option.Option(String),
    member_limit: option.Option(Int),
    expire_date: option.Option(Int),
    creates_join_request: option.Option(Bool),
  )
}

Constructors

• CreateChatInviteLinkParameters(
    chat_id: IntOrString,
    name: option.Option(String),
    member_limit: option.Option(Int),
    expire_date: option.Option(Int),
    creates_join_request: option.Option(Bool),
  )

  Arguments

  chat_id

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

  name

  Invite link name; 0-32 characters

  member_limit

  The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

  expire_date

  Point in time (Unix timestamp) when the link will expire.

  creates_join_request

  True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified

pub type CreateChatSubscriptionInviteLinkParameters {
  CreateChatSubscriptionInviteLinkParameters(
    chat_id: IntOrString,
    name: option.Option(String),
    period: Int,
    amount: Int,
  )
}

Constructors

• CreateChatSubscriptionInviteLinkParameters(
    chat_id: IntOrString,
    name: option.Option(String),
    period: Int,
    amount: Int,
  )

  Arguments

  chat_id

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

  name

  Invite link name; 0-32 characters

  period

  The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).

  amount

  The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-2500

pub type CreateForumTopicParameters {
  CreateForumTopicParameters(
    chat_id: IntOrString,
    name: String,
    icon_color: option.Option(Int),
    icon_custom_emoji_id: option.Option(String),
  )
}

Constructors

• CreateForumTopicParameters(
    chat_id: IntOrString,
    name: String,
    icon_color: option.Option(Int),
    icon_custom_emoji_id: option.Option(String),
  )

  Arguments

  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

  Color of the topic icon in RGB format

  icon_custom_emoji_id

  Unique identifier of the custom emoji shown as the topic icon

pub type CreateInvoiceLinkParameters {
  CreateInvoiceLinkParameters(
    business_connection_id: option.Option(String),
    title: String,
    description: String,
    payload: String,
    provider_token: option.Option(String),
    currency: String,
    prices: List(LabeledPrice),
    subscription_period: option.Option(Int),
    max_tip_amount: option.Option(Int),
    suggested_tip_amounts: option.Option(List(Int)),
    provider_data: option.Option(String),
    photo_url: option.Option(String),
    photo_size: option.Option(Int),
    photo_width: option.Option(Int),
    photo_height: option.Option(Int),
    need_name: option.Option(Bool),
    need_phone_number: option.Option(Bool),
    need_email: option.Option(Bool),
    need_shipping_address: option.Option(Bool),
    send_phone_number_to_provider: option.Option(Bool),
    send_email_to_provider: option.Option(Bool),
    is_flexible: option.Option(Bool),
  )
}

Constructors

• CreateInvoiceLinkParameters(
    business_connection_id: option.Option(String),
    title: String,
    description: String,
    payload: String,
    provider_token: option.Option(String),
    currency: String,
    prices: List(LabeledPrice),
    subscription_period: option.Option(Int),
    max_tip_amount: option.Option(Int),
    suggested_tip_amounts: option.Option(List(Int)),
    provider_data: option.Option(String),
    photo_url: option.Option(String),
    photo_size: option.Option(Int),
    photo_width: option.Option(Int),
    photo_height: option.Option(Int),
    need_name: option.Option(Bool),
    need_phone_number: option.Option(Bool),
    need_email: option.Option(Bool),
    need_shipping_address: option.Option(Bool),
    send_phone_number_to_provider: option.Option(Bool),
    send_email_to_provider: option.Option(Bool),
    is_flexible: option.Option(Bool),
  )

  Arguments

  business_connection_id

  Unique identifier of the business connection

  title

  Product name, 1-32 characters

  description

  Product description, 1-255 characters

  payload

  Bot-defined invoice payload, 1-128 bytes

  provider_token

  Payment provider token

  currency

  Three-letter ISO 4217 currency code

  prices

  Price breakdown

  subscription_period

  Subscription period in seconds

  max_tip_amount

  Maximum accepted amount for tips

  suggested_tip_amounts

  Suggested amounts of tips

  provider_data

  JSON-serialized data about the invoice

  photo_url

  URL of the product photo

  photo_size

  Photo size in bytes

  photo_width

  Photo width

  photo_height

  Photo height

  need_name

  Require user’s full name

  need_phone_number

  Require user’s phone number

  need_email

  Require user’s email address

  need_shipping_address

  Require user’s shipping address

  send_phone_number_to_provider

  Send phone number to provider

  send_email_to_provider

  Send email to provider

  is_flexible

  Final price depends on shipping method

pub type CreateNewStickerSetParameters {
  CreateNewStickerSetParameters(
    user_id: Int,
    name: String,
    title: String,
    stickers: List(InputSticker),
    sticker_type: option.Option(String),
    needs_repainting: option.Option(Bool),
  )
}

Constructors

• CreateNewStickerSetParameters(
    user_id: Int,
    name: String,
    title: String,
    stickers: List(InputSticker),
    sticker_type: option.Option(String),
    needs_repainting: option.Option(Bool),
  )

  Arguments

  user_id

  User identifier of created sticker set owner

  name

  Short name of sticker set, to be used in t.me/addstickers/ URLs

  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

  Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.

  needs_repainting

  Pass True if stickers in the sticker set must be repainted to the color of text when used in messages

pub type DeclineChatJoinRequestParameters {
  DeclineChatJoinRequestParameters(
    chat_id: IntOrString,
    user_id: Int,
  )
}

Constructors

• DeclineChatJoinRequestParameters(
    chat_id: IntOrString,
    user_id: Int,
  )

  Arguments

  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

pub type DeleteAllMessageReactionsParameters {
  DeleteAllMessageReactionsParameters(
    chat_id: IntOrString,
    message_id: Int,
  )
}

Constructors

• DeleteAllMessageReactionsParameters(
    chat_id: IntOrString,
    message_id: Int,
  )

  Arguments

  chat_id

  Unique identifier for the target chat or username of the target channel

  message_id

  Identifier of the target message

pub type DeleteBusinessMessagesParameters {
  DeleteBusinessMessagesParameters(
    business_connection_id: String,
    message_ids: List(Int),
  )
}

Constructors

• DeleteBusinessMessagesParameters(
    business_connection_id: String,
    message_ids: List(Int),
  )

  Arguments

  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

pub type DeleteChatPhotoParameters {
  DeleteChatPhotoParameters(chat_id: IntOrString)
}

Constructors

• DeleteChatPhotoParameters(chat_id: IntOrString)

  Arguments

  chat_id

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

pub type DeleteChatStickerSetParameters {
  DeleteChatStickerSetParameters(chat_id: IntOrString)
}

Constructors

• DeleteChatStickerSetParameters(chat_id: IntOrString)

  Arguments

  chat_id

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

pub type DeleteEphemeralMessageParameters {
  DeleteEphemeralMessageParameters(
    chat_id: IntOrString,
    receiver_user_id: Int,
    ephemeral_message_id: Int,
  )
}

Constructors

• DeleteEphemeralMessageParameters(
    chat_id: IntOrString,
    receiver_user_id: Int,
    ephemeral_message_id: Int,
  )

  Arguments

  chat_id

  Unique identifier for the target chat or username of the target channel

  receiver_user_id

  Unique identifier of the user who received the ephemeral message

  ephemeral_message_id

  Identifier of the ephemeral message to delete

pub type DeleteForumTopicParameters {
  DeleteForumTopicParameters(
    chat_id: IntOrString,
    message_thread_id: Int,
  )
}

Constructors

• DeleteForumTopicParameters(
    chat_id: IntOrString,
    message_thread_id: Int,
  )

  Arguments

  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

pub type DeleteMessageParameters {
  DeleteMessageParameters(chat_id: IntOrString, message_id: Int)
}

Constructors

• DeleteMessageParameters(chat_id: IntOrString, message_id: Int)

  Arguments

  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

pub type DeleteMessageReactionParameters {
  DeleteMessageReactionParameters(
    chat_id: IntOrString,
    message_id: Int,
    user_id: Int,
    reaction: ReactionType,
  )
}