tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/draft_message.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Contains information about a message draft.
+  #
+  # @attr reply_to_message_id [Integer] Identifier of the message to reply to; 0 if none.
+  # @attr input_message_text [TD::Types::InputMessageContent] Content of the message draft; this should always be of
+  #   type inputMessageText.
+  class DraftMessage < Base
+    attribute :reply_to_message_id, TD::Types::Integer
+    attribute :input_message_text, TD::Types::InputMessageContent
+  end
+end

data/lib/tdlib/types/email_address_authentication_code_info.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Information about the email address authentication code that was sent.
+  #
+  # @attr email_address_pattern [String] Pattern of the email address to which an authentication code was sent.
+  # @attr length [Integer] Length of the code; 0 if unknown.
+  class EmailAddressAuthenticationCodeInfo < Base
+    attribute :email_address_pattern, TD::Types::String
+    attribute :length, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/encrypted_credentials.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains encrypted Telegram Passport data credentials.
+  #
+  # @attr data [String] The encrypted credentials.
+  # @attr hash [String] The decrypted data hash.
+  # @attr secret [String] Secret for data decryption, encrypted with the service's public key.
+  class EncryptedCredentials < Base
+    attribute :data, TD::Types::String
+    attribute :hash, TD::Types::String
+    attribute :secret, TD::Types::String
+  end
+end

data/lib/tdlib/types/encrypted_passport_element.rb

@@ -0,0 +1,25 @@
+module TD::Types
+  # Contains information about an encrypted Telegram Passport element; for bots only.
+  #
+  # @attr type [TD::Types::PassportElementType] Type of Telegram Passport element.
+  # @attr data [String] Encrypted JSON-encoded data about the user.
+  # @attr front_side [TD::Types::DatedFile] The front side of an identity document.
+  # @attr reverse_side [TD::Types::DatedFile, nil] The reverse side of an identity document; may be null.
+  # @attr selfie [TD::Types::DatedFile, nil] Selfie with the document; may be null.
+  # @attr translation [Array<TD::Types::DatedFile>] List of files containing a certified English translation of the
+  #   document.
+  # @attr files [Array<TD::Types::DatedFile>] List of attached files.
+  # @attr value [String] Unencrypted data, phone number or email address.
+  # @attr hash [String] Hash of the entire element.
+  class EncryptedPassportElement < Base
+    attribute :type, TD::Types::PassportElementType
+    attribute :data, TD::Types::String
+    attribute :front_side, TD::Types::DatedFile
+    attribute :reverse_side, TD::Types::DatedFile.optional.default(nil)
+    attribute :selfie, TD::Types::DatedFile.optional.default(nil)
+    attribute :translation, TD::Types::Array.of(TD::Types::DatedFile)
+    attribute :files, TD::Types::Array.of(TD::Types::DatedFile)
+    attribute :value, TD::Types::String
+    attribute :hash, TD::Types::String
+  end
+end

data/lib/tdlib/types/error.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # An object of this type can be returned on every function call, in case of an error.
+  #
+  # @attr code [Integer] Error code; subject to future changes.
+  #   If the error code is 406, the error message must not be processed in any way and must not be displayed to the
+  #   user.
+  # @attr message [String] Error message; subject to future changes.
+  class Error < Base
+    attribute :code, TD::Types::Integer
+    attribute :message, TD::Types::String
+  end
+end

data/lib/tdlib/types/file.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Represents a file.
+  #
+  # @attr id [Integer] Unique file identifier.
+  # @attr size [Integer] File size; 0 if unknown.
+  # @attr expected_size [Integer] Expected file size in case the exact file size is unknown, but an approximate size is
+  #   known.
+  #   Can be used to show download/upload progress.
+  # @attr local [TD::Types::LocalFile] Information about the local copy of the file.
+  # @attr remote [TD::Types::RemoteFile] Information about the remote copy of the file.
+  class File < Base
+    attribute :id, TD::Types::Integer
+    attribute :size, TD::Types::Integer
+    attribute :expected_size, TD::Types::Integer
+    attribute :local, TD::Types::LocalFile
+    attribute :remote, TD::Types::RemoteFile
+  end
+end

data/lib/tdlib/types/file_type.rb

@@ -0,0 +1,25 @@
+module TD::Types
+  # Represents the type of a file.
+  class FileType < Base
+    %w[
+      none
+      animation
+      audio
+      document
+      photo
+      profile_photo
+      secret
+      secret_thumbnail
+      secure
+      sticker
+      thumbnail
+      unknown
+      video
+      video_note
+      voice_note
+      wallpaper
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/file_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/file_type/animation.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is an animation.
+  class FileType::Animation < FileType
+  end
+end

data/lib/tdlib/types/file_type/audio.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is an audio file.
+  class FileType::Audio < FileType
+  end
+end

data/lib/tdlib/types/file_type/document.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a document.
+  class FileType::Document < FileType
+  end
+end

data/lib/tdlib/types/file_type/none.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The data is not a file.
+  class FileType::None < FileType
+  end
+end

data/lib/tdlib/types/file_type/photo.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a photo.
+  class FileType::Photo < FileType
+  end
+end

data/lib/tdlib/types/file_type/profile_photo.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a profile photo.
+  class FileType::ProfilePhoto < FileType
+  end
+end

data/lib/tdlib/types/file_type/secret.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file was sent to a secret chat (the file type is not known to the server).
+  class FileType::Secret < FileType
+  end
+end

data/lib/tdlib/types/file_type/secret_thumbnail.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a thumbnail of a file from a secret chat.
+  class FileType::SecretThumbnail < FileType
+  end
+end

data/lib/tdlib/types/file_type/secure.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a file from Secure storage used for storing Telegram Passport files.
+  class FileType::Secure < FileType
+  end
+end

data/lib/tdlib/types/file_type/sticker.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a sticker.
+  class FileType::Sticker < FileType
+  end
+end

data/lib/tdlib/types/file_type/thumbnail.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a thumbnail of another file.
+  class FileType::Thumbnail < FileType
+  end
+end

data/lib/tdlib/types/file_type/unknown.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file type is not yet known.
+  class FileType::Unknown < FileType
+  end
+end

data/lib/tdlib/types/file_type/video.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a video.
+  class FileType::Video < FileType
+  end
+end

data/lib/tdlib/types/file_type/video_note.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a video note.
+  class FileType::VideoNote < FileType
+  end
+end

data/lib/tdlib/types/file_type/voice_note.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a voice note.
+  class FileType::VoiceNote < FileType
+  end
+end

data/lib/tdlib/types/file_type/wallpaper.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a wallpaper.
+  class FileType::Wallpaper < FileType
+  end
+end

data/lib/tdlib/types/formatted_text.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A text with some entities.
+  #
+  # @attr text [String] The text.
+  # @attr entities [Array<TD::Types::TextEntity>] Entities contained in the text.
+  class FormattedText < Base
+    attribute :text, TD::Types::String
+    attribute :entities, TD::Types::Array.of(TD::Types::TextEntity)
+  end
+end

data/lib/tdlib/types/found_messages.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains a list of messages found by a search.
+  #
+  # @attr messages [Array<TD::Types::Message>] List of messages.
+  # @attr next_from_search_id [Integer] Value to pass as from_search_id to get more results.
+  class FoundMessages < Base
+    attribute :messages, TD::Types::Array.of(TD::Types::Message)
+    attribute :next_from_search_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/game.rb

@@ -0,0 +1,21 @@
+module TD::Types
+  # Describes a game.
+  #
+  # @attr id [Integer] Game ID.
+  # @attr short_name [String] Game short name.
+  #   To share a game use the URL https://t.me/{bot_username}?game={game_short_name}.
+  # @attr title [String] Game title.
+  # @attr text [TD::Types::FormattedText] Game text, usually containing scoreboards for a game.
+  # @attr description [String] Game description.
+  # @attr photo [TD::Types::Photo] Game photo.
+  # @attr animation [TD::Types::Animation, nil] Game animation; may be null.
+  class Game < Base
+    attribute :id, TD::Types::Integer
+    attribute :short_name, TD::Types::String
+    attribute :title, TD::Types::String
+    attribute :text, TD::Types::FormattedText
+    attribute :description, TD::Types::String
+    attribute :photo, TD::Types::Photo
+    attribute :animation, TD::Types::Animation.optional.default(nil)
+  end
+end

data/lib/tdlib/types/game_high_score.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains one row of the game high score table.
+  #
+  # @attr position [Integer] Position in the high score table.
+  # @attr user_id [Integer] User identifier.
+  # @attr score [Integer] User score.
+  class GameHighScore < Base
+    attribute :position, TD::Types::Integer
+    attribute :user_id, TD::Types::Integer
+    attribute :score, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/game_high_scores.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of game high scores.
+  #
+  # @attr scores [Array<TD::Types::GameHighScore>] A list of game high scores.
+  class GameHighScores < Base
+    attribute :scores, TD::Types::Array.of(TD::Types::GameHighScore)
+  end
+end

data/lib/tdlib/types/hashtags.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of hashtags.
+  #
+  # @attr hashtags [Array<String>] A list of hashtags.
+  class Hashtags < Base
+    attribute :hashtags, TD::Types::Array.of(TD::Types::String)
+  end
+end

data/lib/tdlib/types/identity_document.rb

@@ -0,0 +1,19 @@
+module TD::Types
+  # An identity document.
+  #
+  # @attr number [String] Document number; 1-24 characters.
+  # @attr expiry_date [TD::Types::Date, nil] Document expiry date; may be null.
+  # @attr front_side [TD::Types::DatedFile] Front side of the document.
+  # @attr reverse_side [TD::Types::DatedFile] Reverse side of the document; only for driver license and identity card.
+  # @attr selfie [TD::Types::DatedFile, nil] Selfie with the document; may be null.
+  # @attr translation [Array<TD::Types::DatedFile>] List of files containing a certified English translation of the
+  #   document.
+  class IdentityDocument < Base
+    attribute :number, TD::Types::String
+    attribute :expiry_date, TD::Types::Date.optional.default(nil)
+    attribute :front_side, TD::Types::DatedFile
+    attribute :reverse_side, TD::Types::DatedFile
+    attribute :selfie, TD::Types::DatedFile.optional.default(nil)
+    attribute :translation, TD::Types::Array.of(TD::Types::DatedFile)
+  end
+end

data/lib/tdlib/types/imported_contacts.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents the result of an ImportContacts request.
+  #
+  # @attr user_ids [Array<Integer>] User identifiers of the imported contacts in the same order as they were specified
+  #   in the request; 0 if the contact is not yet a registered user.
+  # @attr importer_count [Array<Integer>] The number of users that imported the corresponding contact; 0 for already
+  #   registered users or if unavailable.
+  class ImportedContacts < Base
+    attribute :user_ids, TD::Types::Array.of(TD::Types::Integer)
+    attribute :importer_count, TD::Types::Array.of(TD::Types::Integer)
+  end
+end

data/lib/tdlib/types/inline_keyboard_button.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a single button in an inline keyboard.
+  #
+  # @attr text [String] Text of the button.
+  # @attr type [TD::Types::InlineKeyboardButtonType] Type of the button.
+  class InlineKeyboardButton < Base
+    attribute :text, TD::Types::String
+    attribute :type, TD::Types::InlineKeyboardButtonType
+  end
+end

data/lib/tdlib/types/inline_keyboard_button_type.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Describes the type of an inline keyboard button.
+  class InlineKeyboardButtonType < Base
+    %w[
+      url
+      callback
+      callback_game
+      switch_inline
+      buy
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/inline_keyboard_button_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/inline_keyboard_button_type/buy.rb

@@ -0,0 +1,7 @@
+module TD::Types
+  # A button to buy something.
+  # This button must be in the first column and row of the keyboard and can be attached only to a message with content
+  #   of the type messageInvoice.
+  class InlineKeyboardButtonType::Buy < InlineKeyboardButtonType
+  end
+end

data/lib/tdlib/types/inline_keyboard_button_type/callback.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A button that sends a special callback query to a bot.
+  #
+  # @attr data [String] Data to be sent to the bot via a callback query.
+  class InlineKeyboardButtonType::Callback < InlineKeyboardButtonType
+    attribute :data, TD::Types::String
+  end
+end

data/lib/tdlib/types/inline_keyboard_button_type/callback_game.rb

@@ -0,0 +1,7 @@
+module TD::Types
+  # A button with a game that sends a special callback query to a bot.
+  # This button must be in the first column and row of the keyboard and can be attached only to a message with content
+  #   of the type messageGame.
+  class InlineKeyboardButtonType::CallbackGame < InlineKeyboardButtonType
+  end
+end

data/lib/tdlib/types/inline_keyboard_button_type/switch_inline.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A button that forces an inline query to the bot to be inserted in the input field.
+  #
+  # @attr query [String] Inline query to be sent to the bot.
+  # @attr in_current_chat [Boolean] True, if the inline query should be sent from the current chat.
+  class InlineKeyboardButtonType::SwitchInline < InlineKeyboardButtonType
+    attribute :query, TD::Types::String
+    attribute :in_current_chat, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/inline_keyboard_button_type/url.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A button that opens a specified URL.
+  #
+  # @attr url [String] HTTP or tg:// URL to open.
+  class InlineKeyboardButtonType::Url < InlineKeyboardButtonType
+    attribute :url, TD::Types::String
+  end
+end

data/lib/tdlib/types/inline_query_result.rb

@@ -0,0 +1,21 @@
+module TD::Types
+  # Represents a single result of an inline query.
+  class InlineQueryResult < Base
+    %w[
+      article
+      contact
+      location
+      venue
+      game
+      animation
+      audio
+      document
+      photo
+      sticker
+      video
+      voice_note
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/inline_query_result/#{type}"
+    end
+  end
+end