telegram-bot-openapi 7.2.1

data/docs/Dice.md

@@ -0,0 +1,20 @@
+# TelegramBot::Dice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emoji** | **String** | Emoji on which the dice throw animation is based |  |
+| **value** | **Integer** | Value of the dice, 1-6 for \"🎲\", \"🎯\" and \"🎳\" base emoji, 1-5 for \"🏀\" and \"⚽\" base emoji, 1-64 for \"🎰\" base emoji |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::Dice.new(
+  emoji: null,
+  value: null
+)
+```
+

data/docs/Document.md

@@ -0,0 +1,28 @@
+# TelegramBot::Document
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | Identifier for this file, which can be used to download or reuse the file |  |
+| **file_unique_id** | **String** | 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. |  |
+| **thumbnail** | [**PhotoSize**](PhotoSize.md) | Optional. Document thumbnail as defined by sender | [optional] |
+| **file_name** | **String** | Optional. Original filename as defined by sender | [optional] |
+| **mime_type** | **String** | Optional. MIME type of the file as defined by sender | [optional] |
+| **file_size** | **Integer** | 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. | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::Document.new(
+  file_id: null,
+  file_unique_id: null,
+  thumbnail: null,
+  file_name: null,
+  mime_type: null,
+  file_size: null
+)
+```
+

data/docs/EditMessageText200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::EditMessageText200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | [**Hash<String, EditMessageText200ResponseResultValue>**](EditMessageText200ResponseResultValue.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::EditMessageText200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/EditMessageText200ResponseResultValue.md

@@ -0,0 +1,49 @@
+# TelegramBot::EditMessageText200ResponseResultValue
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'telegram-bot'
+
+TelegramBot::EditMessageText200ResponseResultValue.openapi_one_of
+# =>
+# [
+#   :'Boolean',
+#   :'Message'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'telegram-bot'
+
+TelegramBot::EditMessageText200ResponseResultValue.build(data)
+# => #<Boolean:0x00007fdd4aab02a0>
+
+TelegramBot::EditMessageText200ResponseResultValue.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Boolean`
+- `Message`
+- `nil` (if no type matches)
+

data/docs/EncryptedCredentials.md

@@ -0,0 +1,22 @@
+# TelegramBot::EncryptedCredentials
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **String** | Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication |  |
+| **hash** | **String** | Base64-encoded data hash for data authentication |  |
+| **secret** | **String** | Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::EncryptedCredentials.new(
+  data: null,
+  hash: null,
+  secret: null
+)
+```
+

data/docs/EncryptedPassportElement.md

@@ -0,0 +1,36 @@
+# TelegramBot::EncryptedPassportElement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Element type. One of \"personal_details\", \"passport\", \"driver_license\", \"identity_card\", \"internal_passport\", \"address\", \"utility_bill\", \"bank_statement\", \"rental_agreement\", \"passport_registration\", \"temporary_registration\", \"phone_number\", \"email\". |  |
+| **data** | **String** | Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for \"personal_details\", \"passport\", \"driver_license\", \"identity_card\", \"internal_passport\" and \"address\" types. Can be decrypted and verified using the accompanying EncryptedCredentials. | [optional] |
+| **phone_number** | **String** | Optional. User's verified phone number; available only for \"phone_number\" type | [optional] |
+| **email** | **String** | Optional. User's verified email address; available only for \"email\" type | [optional] |
+| **files** | [**Array<PassportFile>**](PassportFile.md) | Optional. Array of encrypted files with documents provided by the user; available only for \"utility_bill\", \"bank_statement\", \"rental_agreement\", \"passport_registration\" and \"temporary_registration\" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. | [optional] |
+| **front_side** | [**PassportFile**](PassportFile.md) | Optional. Encrypted file with the front side of the document, provided by the user; available only for \"passport\", \"driver_license\", \"identity_card\" and \"internal_passport\". The file can be decrypted and verified using the accompanying EncryptedCredentials. | [optional] |
+| **reverse_side** | [**PassportFile**](PassportFile.md) | Optional. Encrypted file with the reverse side of the document, provided by the user; available only for \"driver_license\" and \"identity_card\". The file can be decrypted and verified using the accompanying EncryptedCredentials. | [optional] |
+| **selfie** | [**PassportFile**](PassportFile.md) | Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for \"passport\", \"driver_license\", \"identity_card\" and \"internal_passport\". The file can be decrypted and verified using the accompanying EncryptedCredentials. | [optional] |
+| **translation** | [**Array<PassportFile>**](PassportFile.md) | Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for \"passport\", \"driver_license\", \"identity_card\", \"internal_passport\", \"utility_bill\", \"bank_statement\", \"rental_agreement\", \"passport_registration\" and \"temporary_registration\" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. | [optional] |
+| **hash** | **String** | Base64-encoded element hash for using in PassportElementErrorUnspecified |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::EncryptedPassportElement.new(
+  type: null,
+  data: null,
+  phone_number: null,
+  email: null,
+  files: null,
+  front_side: null,
+  reverse_side: null,
+  selfie: null,
+  translation: null,
+  hash: null
+)
+```
+

data/docs/ExportChatInviteLink200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::ExportChatInviteLink200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ExportChatInviteLink200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/ExternalReplyInfo.md

@@ -0,0 +1,62 @@
+# TelegramBot::ExternalReplyInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **origin** | **Object** | Origin of the message replied to by the given message |  |
+| **chat** | [**Chat**](Chat.md) | Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel. | [optional] |
+| **message_id** | **Integer** | Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. | [optional] |
+| **link_preview_options** | [**LinkPreviewOptions**](LinkPreviewOptions.md) | Optional. Options used for link preview generation for the original message, if it is a text message | [optional] |
+| **animation** | [**Animation**](Animation.md) | Optional. Message is an animation, information about the animation | [optional] |
+| **audio** | [**Audio**](Audio.md) | Optional. Message is an audio file, information about the file | [optional] |
+| **document** | [**Document**](Document.md) | Optional. Message is a general file, information about the file | [optional] |
+| **photo** | [**Array<PhotoSize>**](PhotoSize.md) | Optional. Message is a photo, available sizes of the photo | [optional] |
+| **sticker** | [**Sticker**](Sticker.md) | Optional. Message is a sticker, information about the sticker | [optional] |
+| **story** | [**Story**](Story.md) | Optional. Message is a forwarded story | [optional] |
+| **video** | [**Video**](Video.md) | Optional. Message is a video, information about the video | [optional] |
+| **video_note** | [**VideoNote**](VideoNote.md) | Optional. Message is a video note, information about the video message | [optional] |
+| **voice** | [**Voice**](Voice.md) | Optional. Message is a voice message, information about the file | [optional] |
+| **has_media_spoiler** | **Boolean** | Optional. True, if the message media is covered by a spoiler animation | [optional] |
+| **contact** | [**Contact**](Contact.md) | Optional. Message is a shared contact, information about the contact | [optional] |
+| **dice** | [**Dice**](Dice.md) | Optional. Message is a dice with random value | [optional] |
+| **game** | [**Game**](Game.md) | Optional. Message is a game, information about the game. More about games: https://core.telegram.org/bots/api#games | [optional] |
+| **giveaway** | [**Giveaway**](Giveaway.md) | Optional. Message is a scheduled giveaway, information about the giveaway | [optional] |
+| **giveaway_winners** | [**GiveawayWinners**](GiveawayWinners.md) | Optional. A giveaway with public winners was completed | [optional] |
+| **invoice** | [**Invoice**](Invoice.md) | Optional. Message is an invoice for a payment, information about the invoice. More about payments: https://core.telegram.org/bots/api#payments | [optional] |
+| **location** | [**Location**](Location.md) | Optional. Message is a shared location, information about the location | [optional] |
+| **poll** | [**Poll**](Poll.md) | Optional. Message is a native poll, information about the poll | [optional] |
+| **venue** | [**Venue**](Venue.md) | Optional. Message is a venue, information about the venue | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ExternalReplyInfo.new(
+  origin: null,
+  chat: null,
+  message_id: null,
+  link_preview_options: null,
+  animation: null,
+  audio: null,
+  document: null,
+  photo: null,
+  sticker: null,
+  story: null,
+  video: null,
+  video_note: null,
+  voice: null,
+  has_media_spoiler: null,
+  contact: null,
+  dice: null,
+  game: null,
+  giveaway: null,
+  giveaway_winners: null,
+  invoice: null,
+  location: null,
+  poll: null,
+  venue: null
+)
+```
+

data/docs/File.md

@@ -0,0 +1,24 @@
+# TelegramBot::File
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | Identifier for this file, which can be used to download or reuse the file |  |
+| **file_unique_id** | **String** | 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. |  |
+| **file_size** | **Integer** | 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. | [optional] |
+| **file_path** | **String** | Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::File.new(
+  file_id: null,
+  file_unique_id: null,
+  file_size: null,
+  file_path: null
+)
+```
+

data/docs/ForceReply.md

@@ -0,0 +1,22 @@
+# TelegramBot::ForceReply
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **force_reply** | **Boolean** | Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply' |  |
+| **input_field_placeholder** | **String** | Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters | [optional] |
+| **selective** | **Boolean** | Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ForceReply.new(
+  force_reply: null,
+  input_field_placeholder: null,
+  selective: null
+)
+```
+

data/docs/ForumTopic.md

@@ -0,0 +1,24 @@
+# TelegramBot::ForumTopic
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_thread_id** | **Integer** | Unique identifier of the forum topic |  |
+| **name** | **String** | Name of the topic |  |
+| **icon_color** | **Integer** | Color of the topic icon in RGB format |  |
+| **icon_custom_emoji_id** | **String** | Optional. Unique identifier of the custom emoji shown as the topic icon | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ForumTopic.new(
+  message_thread_id: null,
+  name: null,
+  icon_color: null,
+  icon_custom_emoji_id: null
+)
+```
+

data/docs/ForumTopicCreated.md

@@ -0,0 +1,22 @@
+# TelegramBot::ForumTopicCreated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the topic |  |
+| **icon_color** | **Integer** | Color of the topic icon in RGB format |  |
+| **icon_custom_emoji_id** | **String** | Optional. Unique identifier of the custom emoji shown as the topic icon | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ForumTopicCreated.new(
+  name: null,
+  icon_color: null,
+  icon_custom_emoji_id: null
+)
+```
+

data/docs/ForumTopicEdited.md

@@ -0,0 +1,20 @@
+# TelegramBot::ForumTopicEdited
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Optional. New name of the topic, if it was edited | [optional] |
+| **icon_custom_emoji_id** | **String** | Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ForumTopicEdited.new(
+  name: null,
+  icon_custom_emoji_id: null
+)
+```
+

data/docs/ForwardMessages200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::ForwardMessages200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | [**Array<MessageId>**](MessageId.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ForwardMessages200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/Game.md

@@ -0,0 +1,28 @@
+# TelegramBot::Game
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Title of the game |  |
+| **description** | **String** | Description of the game |  |
+| **photo** | [**Array<PhotoSize>**](PhotoSize.md) | Photo that will be displayed in the game message in chats. |  |
+| **text** | **String** | Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. | [optional] |
+| **text_entities** | [**Array<MessageEntity>**](MessageEntity.md) | Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. | [optional] |
+| **animation** | [**Animation**](Animation.md) | Optional. Animation that will be displayed in the game message in chats. Upload via BotFather | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::Game.new(
+  title: null,
+  description: null,
+  photo: null,
+  text: null,
+  text_entities: null,
+  animation: null
+)
+```
+

data/docs/GameHighScore.md

@@ -0,0 +1,22 @@
+# TelegramBot::GameHighScore
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **position** | **Integer** | Position in high score table for the game |  |
+| **user** | [**User**](User.md) | User |  |
+| **score** | **Integer** | Score |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GameHighScore.new(
+  position: null,
+  user: null,
+  score: null
+)
+```
+

data/docs/GetBusinessConnection200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetBusinessConnection200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | [**BusinessConnection**](BusinessConnection.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetBusinessConnection200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetChat200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetChat200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | [**Chat**](Chat.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetChat200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetChatAdministrators200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetChatAdministrators200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetChatAdministrators200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetChatMember200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetChatMember200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | **Object** | This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: - ChatMemberOwner - ChatMemberAdministrator - ChatMemberMember - ChatMemberRestricted - ChatMemberLeft - ChatMemberBanned | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetChatMember200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetChatMemberCount200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetChatMemberCount200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetChatMemberCount200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetChatMenuButton200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetChatMenuButton200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | **Object** | This object describes the bot's menu button in a private chat. It should be one of - MenuButtonCommands - MenuButtonWebApp - MenuButtonDefault If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands. | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetChatMenuButton200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetFile200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetFile200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | **File** |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetFile200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetForumTopicIconStickers200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetForumTopicIconStickers200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | [**Array<Sticker>**](Sticker.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetForumTopicIconStickers200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetGameHighScores200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetGameHighScores200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | [**Array<GameHighScore>**](GameHighScore.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetGameHighScores200Response.new(
+  ok: null,
+  result: null
+)
+```
+

data/docs/GetMe200Response.md

@@ -0,0 +1,20 @@
+# TelegramBot::GetMe200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+| **result** | [**User**](User.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::GetMe200Response.new(
+  ok: null,
+  result: null
+)
+```
+