telegram-bot-openapi 7.2.1

data/docs/PassportElementErrorUnspecified.md

@@ -0,0 +1,24 @@
+# TelegramBot::PassportElementErrorUnspecified
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | **String** | Error source, must be unspecified |  |
+| **type** | **String** | Type of element of the user's Telegram Passport which has the issue |  |
+| **element_hash** | **String** | Base64-encoded element hash |  |
+| **message** | **String** | Error message |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::PassportElementErrorUnspecified.new(
+  source: null,
+  type: null,
+  element_hash: null,
+  message: null
+)
+```
+

data/docs/PassportFile.md

@@ -0,0 +1,24 @@
+# TelegramBot::PassportFile
+
+## 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** | File size in bytes |  |
+| **file_date** | **Integer** | Unix time when the file was uploaded |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::PassportFile.new(
+  file_id: null,
+  file_unique_id: null,
+  file_size: null,
+  file_date: null
+)
+```
+

data/docs/PhotoSize.md

@@ -0,0 +1,26 @@
+# TelegramBot::PhotoSize
+
+## 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. |  |
+| **width** | **Integer** | Photo width |  |
+| **height** | **Integer** | Photo height |  |
+| **file_size** | **Integer** | Optional. File size in bytes | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::PhotoSize.new(
+  file_id: null,
+  file_unique_id: null,
+  width: null,
+  height: null,
+  file_size: null
+)
+```
+

data/docs/Poll.md

@@ -0,0 +1,42 @@
+# TelegramBot::Poll
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique poll identifier |  |
+| **question** | **String** | Poll question, 1-300 characters |  |
+| **options** | [**Array<PollOption>**](PollOption.md) | List of poll options |  |
+| **total_voter_count** | **Integer** | Total number of users that voted in the poll |  |
+| **is_closed** | **Boolean** | True, if the poll is closed |  |
+| **is_anonymous** | **Boolean** | True, if the poll is anonymous |  |
+| **type** | **String** | Poll type, currently can be \"regular\" or \"quiz\" |  |
+| **allows_multiple_answers** | **Boolean** | True, if the poll allows multiple answers |  |
+| **correct_option_id** | **Integer** | Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot. | [optional] |
+| **explanation** | **String** | Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters | [optional] |
+| **explanation_entities** | [**Array<MessageEntity>**](MessageEntity.md) | Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation | [optional] |
+| **open_period** | **Integer** | Optional. Amount of time in seconds the poll will be active after creation | [optional] |
+| **close_date** | **Integer** | Optional. Point in time (Unix timestamp) when the poll will be automatically closed | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::Poll.new(
+  id: null,
+  question: null,
+  options: null,
+  total_voter_count: null,
+  is_closed: null,
+  is_anonymous: null,
+  type: null,
+  allows_multiple_answers: null,
+  correct_option_id: null,
+  explanation: null,
+  explanation_entities: null,
+  open_period: null,
+  close_date: null
+)
+```
+

data/docs/PollAnswer.md

@@ -0,0 +1,24 @@
+# TelegramBot::PollAnswer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **poll_id** | **String** | Unique poll identifier |  |
+| **voter_chat** | [**Chat**](Chat.md) | Optional. The chat that changed the answer to the poll, if the voter is anonymous | [optional] |
+| **user** | [**User**](User.md) | Optional. The user that changed the answer to the poll, if the voter isn't anonymous | [optional] |
+| **option_ids** | **Array<Integer>** | 0-based identifiers of chosen answer options. May be empty if the vote was retracted. |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::PollAnswer.new(
+  poll_id: null,
+  voter_chat: null,
+  user: null,
+  option_ids: null
+)
+```
+

data/docs/PollOption.md

@@ -0,0 +1,20 @@
+# TelegramBot::PollOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | Option text, 1-100 characters |  |
+| **voter_count** | **Integer** | Number of users that voted for this option |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::PollOption.new(
+  text: null,
+  voter_count: null
+)
+```
+

data/docs/PreCheckoutQuery.md

@@ -0,0 +1,30 @@
+# TelegramBot::PreCheckoutQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique query identifier |  |
+| **from** | [**User**](User.md) | User who sent the query |  |
+| **currency** | **String** | Three-letter ISO 4217 currency code |  |
+| **total_amount** | **Integer** | Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). |  |
+| **invoice_payload** | **String** | Bot specified invoice payload |  |
+| **shipping_option_id** | **String** | Optional. Identifier of the shipping option chosen by the user | [optional] |
+| **order_info** | [**OrderInfo**](OrderInfo.md) | Optional. Order information provided by the user | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::PreCheckoutQuery.new(
+  id: null,
+  from: null,
+  currency: null,
+  total_amount: null,
+  invoice_payload: null,
+  shipping_option_id: null,
+  order_info: null
+)
+```
+

data/docs/ProximityAlertTriggered.md

@@ -0,0 +1,22 @@
+# TelegramBot::ProximityAlertTriggered
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **traveler** | [**User**](User.md) | User that triggered the alert |  |
+| **watcher** | [**User**](User.md) | User that set the alert |  |
+| **distance** | **Integer** | The distance between the users |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ProximityAlertTriggered.new(
+  traveler: null,
+  watcher: null,
+  distance: null
+)
+```
+

data/docs/ReactionCount.md

@@ -0,0 +1,20 @@
+# TelegramBot::ReactionCount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **Object** | Type of the reaction |  |
+| **total_count** | **Integer** | Number of times the reaction was added |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ReactionCount.new(
+  type: null,
+  total_count: null
+)
+```
+

data/docs/ReactionTypeCustomEmoji.md

@@ -0,0 +1,20 @@
+# TelegramBot::ReactionTypeCustomEmoji
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of the reaction, always \"custom_emoji\" |  |
+| **custom_emoji_id** | **String** | Custom emoji identifier |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ReactionTypeCustomEmoji.new(
+  type: null,
+  custom_emoji_id: null
+)
+```
+

data/docs/ReactionTypeEmoji.md

@@ -0,0 +1,20 @@
+# TelegramBot::ReactionTypeEmoji
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of the reaction, always \"emoji\" |  |
+| **emoji** | **String** | Reaction emoji. Currently, it can be one of \"👍\", \"👎\", \"❤\", \"🔥\", \"🥰\", \"👏\", \"😁\", \"🤔\", \"🤯\", \"😱\", \"🤬\", \"😢\", \"🎉\", \"🤩\", \"🤮\", \"💩\", \"🙏\", \"👌\", \"🕊\", \"🤡\", \"🥱\", \"🥴\", \"😍\", \"🐳\", \"❤‍🔥\", \"🌚\", \"🌭\", \"💯\", \"🤣\", \"⚡\", \"🍌\", \"🏆\", \"💔\", \"🤨\", \"😐\", \"🍓\", \"🍾\", \"💋\", \"🖕\", \"😈\", \"😴\", \"😭\", \"🤓\", \"👻\", \"👨‍💻\", \"👀\", \"🎃\", \"🙈\", \"😇\", \"😨\", \"🤝\", \"✍\", \"🤗\", \"🫡\", \"🎅\", \"🎄\", \"☃\", \"💅\", \"🤪\", \"🗿\", \"🆒\", \"💘\", \"🙉\", \"🦄\", \"😘\", \"💊\", \"🙊\", \"😎\", \"👾\", \"🤷‍♂\", \"🤷\", \"🤷‍♀\", \"😡\" |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ReactionTypeEmoji.new(
+  type: null,
+  emoji: null
+)
+```
+

data/docs/ReplyKeyboardMarkup.md

@@ -0,0 +1,28 @@
+# TelegramBot::ReplyKeyboardMarkup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keyboard** | **Array<Array<KeyboardButton>>** | Array of button rows, each represented by an Array of KeyboardButton objects |  |
+| **is_persistent** | **Boolean** | Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. | [optional] |
+| **resize_keyboard** | **Boolean** | Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard. | [optional] |
+| **one_time_keyboard** | **Boolean** | Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false. | [optional] |
+| **input_field_placeholder** | **String** | Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters | [optional] |
+| **selective** | **Boolean** | Optional. Use this parameter if you want to show the keyboard to 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. Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ReplyKeyboardMarkup.new(
+  keyboard: null,
+  is_persistent: null,
+  resize_keyboard: null,
+  one_time_keyboard: null,
+  input_field_placeholder: null,
+  selective: null
+)
+```
+

data/docs/ReplyKeyboardRemove.md

@@ -0,0 +1,20 @@
+# TelegramBot::ReplyKeyboardRemove
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remove_keyboard** | **Boolean** | Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) |  |
+| **selective** | **Boolean** | Optional. Use this parameter if you want to remove the keyboard for 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. Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ReplyKeyboardRemove.new(
+  remove_keyboard: null,
+  selective: null
+)
+```
+

data/docs/ReplyParameters.md

@@ -0,0 +1,30 @@
+# TelegramBot::ReplyParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **Integer** | Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified |  |
+| **chat_id** | [**Hash<String, SendMessageChatIdParameterValue>**](SendMessageChatIdParameterValue.md) | Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. | [optional] |
+| **allow_sending_without_reply** | **Boolean** | Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account. | [optional] |
+| **quote** | **String** | Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message. | [optional] |
+| **quote_parse_mode** | **String** | Optional. Mode for parsing entities in the quote. See formatting options for more details. | [optional] |
+| **quote_entities** | [**Array<MessageEntity>**](MessageEntity.md) | Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode. | [optional] |
+| **quote_position** | **Integer** | Optional. Position of the quote in the original message in UTF-16 code units | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ReplyParameters.new(
+  message_id: null,
+  chat_id: null,
+  allow_sending_without_reply: null,
+  quote: null,
+  quote_parse_mode: null,
+  quote_entities: null,
+  quote_position: null
+)
+```
+

data/docs/ResponseParameters.md

@@ -0,0 +1,20 @@
+# TelegramBot::ResponseParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **migrate_to_chat_id** | **Integer** | Optional. The group has been migrated to a supergroup with the specified identifier. 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. | [optional] |
+| **retry_after** | **Integer** | Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ResponseParameters.new(
+  migrate_to_chat_id: null,
+  retry_after: null
+)
+```
+

data/docs/SendMediaGroup200Response.md

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

data/docs/SendMediaGroupMediaParameterValue.md

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

data/docs/SendMessage200Response.md

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

data/docs/SendMessageChatIdParameterValue.md

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

data/docs/SendMessageReplyMarkupParameterValue.md

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

data/docs/SendPhotoPhotoParameterValue.md

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

data/docs/SentWebAppMessage.md

@@ -0,0 +1,18 @@
+# TelegramBot::SentWebAppMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **inline_message_id** | **String** | Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::SentWebAppMessage.new(
+  inline_message_id: null
+)
+```
+

data/docs/SetWebhook200Response.md

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