telegram-bot-openapi 7.2.1

data/docs/ChatJoinRequest.md

@@ -0,0 +1,28 @@
+# TelegramBot::ChatJoinRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chat** | [**Chat**](Chat.md) | Chat to which the request was sent |  |
+| **from** | [**User**](User.md) | User that sent the join request |  |
+| **user_chat_id** | **Integer** | 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** | **Integer** | Date the request was sent in Unix time |  |
+| **bio** | **String** | Optional. Bio of the user. | [optional] |
+| **invite_link** | [**ChatInviteLink**](ChatInviteLink.md) | Optional. Chat invite link that was used by the user to send the join request | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatJoinRequest.new(
+  chat: null,
+  from: null,
+  user_chat_id: null,
+  date: null,
+  bio: null,
+  invite_link: null
+)
+```
+

data/docs/ChatLocation.md

@@ -0,0 +1,20 @@
+# TelegramBot::ChatLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**Location**](Location.md) | The location to which the supergroup is connected. Can't be a live location. |  |
+| **address** | **String** | Location address; 1-64 characters, as defined by the chat owner |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatLocation.new(
+  location: null,
+  address: null
+)
+```
+

data/docs/ChatMemberAdministrator.md

@@ -0,0 +1,54 @@
+# TelegramBot::ChatMemberAdministrator
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The member's status in the chat, always \"administrator\" |  |
+| **user** | [**User**](User.md) | Information about the user |  |
+| **can_be_edited** | **Boolean** | True, if the bot is allowed to edit administrator privileges of that user |  |
+| **is_anonymous** | **Boolean** | True, if the user's presence in the chat is hidden |  |
+| **can_manage_chat** | **Boolean** | True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. |  |
+| **can_delete_messages** | **Boolean** | True, if the administrator can delete messages of other users |  |
+| **can_manage_video_chats** | **Boolean** | True, if the administrator can manage video chats |  |
+| **can_restrict_members** | **Boolean** | True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics |  |
+| **can_promote_members** | **Boolean** | 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** | **Boolean** | True, if the user is allowed to change the chat title, photo and other settings |  |
+| **can_invite_users** | **Boolean** | True, if the user is allowed to invite new users to the chat |  |
+| **can_post_stories** | **Boolean** | True, if the administrator can post stories to the chat |  |
+| **can_edit_stories** | **Boolean** | True, if the administrator can edit stories posted by other users |  |
+| **can_delete_stories** | **Boolean** | True, if the administrator can delete stories posted by other users |  |
+| **can_post_messages** | **Boolean** | Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only | [optional] |
+| **can_edit_messages** | **Boolean** | Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only | [optional] |
+| **can_pin_messages** | **Boolean** | Optional. True, if the user is allowed to pin messages; for groups and supergroups only | [optional] |
+| **can_manage_topics** | **Boolean** | Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | [optional] |
+| **custom_title** | **String** | Optional. Custom title for this user | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatMemberAdministrator.new(
+  status: null,
+  user: null,
+  can_be_edited: null,
+  is_anonymous: null,
+  can_manage_chat: null,
+  can_delete_messages: null,
+  can_manage_video_chats: null,
+  can_restrict_members: null,
+  can_promote_members: null,
+  can_change_info: null,
+  can_invite_users: null,
+  can_post_stories: null,
+  can_edit_stories: null,
+  can_delete_stories: null,
+  can_post_messages: null,
+  can_edit_messages: null,
+  can_pin_messages: null,
+  can_manage_topics: null,
+  custom_title: null
+)
+```
+

data/docs/ChatMemberBanned.md

@@ -0,0 +1,22 @@
+# TelegramBot::ChatMemberBanned
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The member's status in the chat, always \"kicked\" |  |
+| **user** | [**User**](User.md) | Information about the user |  |
+| **until_date** | **Integer** | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatMemberBanned.new(
+  status: null,
+  user: null,
+  until_date: null
+)
+```
+

data/docs/ChatMemberLeft.md

@@ -0,0 +1,20 @@
+# TelegramBot::ChatMemberLeft
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The member's status in the chat, always \"left\" |  |
+| **user** | [**User**](User.md) | Information about the user |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatMemberLeft.new(
+  status: null,
+  user: null
+)
+```
+

data/docs/ChatMemberMember.md

@@ -0,0 +1,20 @@
+# TelegramBot::ChatMemberMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The member's status in the chat, always \"member\" |  |
+| **user** | [**User**](User.md) | Information about the user |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatMemberMember.new(
+  status: null,
+  user: null
+)
+```
+

data/docs/ChatMemberOwner.md

@@ -0,0 +1,24 @@
+# TelegramBot::ChatMemberOwner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The member's status in the chat, always \"creator\" |  |
+| **user** | [**User**](User.md) | Information about the user |  |
+| **is_anonymous** | **Boolean** | True, if the user's presence in the chat is hidden |  |
+| **custom_title** | **String** | Optional. Custom title for this user | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatMemberOwner.new(
+  status: null,
+  user: null,
+  is_anonymous: null,
+  custom_title: null
+)
+```
+

data/docs/ChatMemberRestricted.md

@@ -0,0 +1,52 @@
+# TelegramBot::ChatMemberRestricted
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The member's status in the chat, always \"restricted\" |  |
+| **user** | [**User**](User.md) | Information about the user |  |
+| **is_member** | **Boolean** | True, if the user is a member of the chat at the moment of the request |  |
+| **can_send_messages** | **Boolean** | True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues |  |
+| **can_send_audios** | **Boolean** | True, if the user is allowed to send audios |  |
+| **can_send_documents** | **Boolean** | True, if the user is allowed to send documents |  |
+| **can_send_photos** | **Boolean** | True, if the user is allowed to send photos |  |
+| **can_send_videos** | **Boolean** | True, if the user is allowed to send videos |  |
+| **can_send_video_notes** | **Boolean** | True, if the user is allowed to send video notes |  |
+| **can_send_voice_notes** | **Boolean** | True, if the user is allowed to send voice notes |  |
+| **can_send_polls** | **Boolean** | True, if the user is allowed to send polls |  |
+| **can_send_other_messages** | **Boolean** | True, if the user is allowed to send animations, games, stickers and use inline bots |  |
+| **can_add_web_page_previews** | **Boolean** | True, if the user is allowed to add web page previews to their messages |  |
+| **can_change_info** | **Boolean** | True, if the user is allowed to change the chat title, photo and other settings |  |
+| **can_invite_users** | **Boolean** | True, if the user is allowed to invite new users to the chat |  |
+| **can_pin_messages** | **Boolean** | True, if the user is allowed to pin messages |  |
+| **can_manage_topics** | **Boolean** | True, if the user is allowed to create forum topics |  |
+| **until_date** | **Integer** | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatMemberRestricted.new(
+  status: null,
+  user: null,
+  is_member: null,
+  can_send_messages: null,
+  can_send_audios: null,
+  can_send_documents: null,
+  can_send_photos: null,
+  can_send_videos: null,
+  can_send_video_notes: null,
+  can_send_voice_notes: null,
+  can_send_polls: null,
+  can_send_other_messages: null,
+  can_add_web_page_previews: null,
+  can_change_info: null,
+  can_invite_users: null,
+  can_pin_messages: null,
+  can_manage_topics: null,
+  until_date: null
+)
+```
+

data/docs/ChatMemberUpdated.md

@@ -0,0 +1,30 @@
+# TelegramBot::ChatMemberUpdated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chat** | [**Chat**](Chat.md) | Chat the user belongs to |  |
+| **from** | [**User**](User.md) | Performer of the action, which resulted in the change |  |
+| **date** | **Integer** | Date the change was done in Unix time |  |
+| **old_chat_member** | **Object** | Previous information about the chat member |  |
+| **new_chat_member** | **Object** | New information about the chat member |  |
+| **invite_link** | [**ChatInviteLink**](ChatInviteLink.md) | Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only. | [optional] |
+| **via_chat_folder_invite_link** | **Boolean** | Optional. True, if the user joined the chat via a chat folder invite link | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatMemberUpdated.new(
+  chat: null,
+  from: null,
+  date: null,
+  old_chat_member: null,
+  new_chat_member: null,
+  invite_link: null,
+  via_chat_folder_invite_link: null
+)
+```
+

data/docs/ChatPermissions.md

@@ -0,0 +1,44 @@
+# TelegramBot::ChatPermissions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **can_send_messages** | **Boolean** | Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues | [optional] |
+| **can_send_audios** | **Boolean** | Optional. True, if the user is allowed to send audios | [optional] |
+| **can_send_documents** | **Boolean** | Optional. True, if the user is allowed to send documents | [optional] |
+| **can_send_photos** | **Boolean** | Optional. True, if the user is allowed to send photos | [optional] |
+| **can_send_videos** | **Boolean** | Optional. True, if the user is allowed to send videos | [optional] |
+| **can_send_video_notes** | **Boolean** | Optional. True, if the user is allowed to send video notes | [optional] |
+| **can_send_voice_notes** | **Boolean** | Optional. True, if the user is allowed to send voice notes | [optional] |
+| **can_send_polls** | **Boolean** | Optional. True, if the user is allowed to send polls | [optional] |
+| **can_send_other_messages** | **Boolean** | Optional. True, if the user is allowed to send animations, games, stickers and use inline bots | [optional] |
+| **can_add_web_page_previews** | **Boolean** | Optional. True, if the user is allowed to add web page previews to their messages | [optional] |
+| **can_change_info** | **Boolean** | Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups | [optional] |
+| **can_invite_users** | **Boolean** | Optional. True, if the user is allowed to invite new users to the chat | [optional] |
+| **can_pin_messages** | **Boolean** | Optional. True, if the user is allowed to pin messages. Ignored in public supergroups | [optional] |
+| **can_manage_topics** | **Boolean** | Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatPermissions.new(
+  can_send_messages: null,
+  can_send_audios: null,
+  can_send_documents: null,
+  can_send_photos: null,
+  can_send_videos: null,
+  can_send_video_notes: null,
+  can_send_voice_notes: null,
+  can_send_polls: null,
+  can_send_other_messages: null,
+  can_add_web_page_previews: null,
+  can_change_info: null,
+  can_invite_users: null,
+  can_pin_messages: null,
+  can_manage_topics: null
+)
+```
+

data/docs/ChatPhoto.md

@@ -0,0 +1,24 @@
+# TelegramBot::ChatPhoto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **small_file_id** | **String** | 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** | **String** | 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** | **String** | 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** | **String** | 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. |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatPhoto.new(
+  small_file_id: null,
+  small_file_unique_id: null,
+  big_file_id: null,
+  big_file_unique_id: null
+)
+```
+

data/docs/ChatShared.md

@@ -0,0 +1,26 @@
+# TelegramBot::ChatShared
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **Integer** | Identifier of the request |  |
+| **chat_id** | **Integer** | 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** | **String** | Optional. Title of the chat, if the title was requested by the bot. | [optional] |
+| **username** | **String** | Optional. Username of the chat, if the username was requested by the bot and available. | [optional] |
+| **photo** | [**Array<PhotoSize>**](PhotoSize.md) | Optional. Available sizes of the chat photo, if the photo was requested by the bot | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChatShared.new(
+  request_id: null,
+  chat_id: null,
+  title: null,
+  username: null,
+  photo: null
+)
+```
+

data/docs/ChosenInlineResult.md

@@ -0,0 +1,26 @@
+# TelegramBot::ChosenInlineResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result_id** | **String** | The unique identifier for the result that was chosen |  |
+| **from** | [**User**](User.md) | The user that chose the result |  |
+| **location** | [**Location**](Location.md) | Optional. Sender location, only for bots that require user location | [optional] |
+| **inline_message_id** | **String** | 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. | [optional] |
+| **query** | **String** | The query that was used to obtain the result |  |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::ChosenInlineResult.new(
+  result_id: null,
+  from: null,
+  location: null,
+  inline_message_id: null,
+  query: null
+)
+```
+

data/docs/Contact.md

@@ -0,0 +1,26 @@
+# TelegramBot::Contact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Contact's phone number |  |
+| **first_name** | **String** | Contact's first name |  |
+| **last_name** | **String** | Optional. Contact's last name | [optional] |
+| **user_id** | **Integer** | 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. | [optional] |
+| **vcard** | **String** | Optional. Additional data about the contact in the form of a vCard | [optional] |
+
+## Example
+
+```ruby
+require 'telegram-bot'
+
+instance = TelegramBot::Contact.new(
+  phone_number: null,
+  first_name: null,
+  last_name: null,
+  user_id: null,
+  vcard: null
+)
+```
+

data/docs/CopyMessage200Response.md

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

data/docs/CreateChatInviteLink200Response.md

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

data/docs/CreateForumTopic200Response.md

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