tdlib-ruby 1.0.0 → 2.0.0

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

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents an animation file.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr animation [TD::Types::Animation] Animation file.
+  # @attr title [String] Animation title.
+  class InlineQueryResult::Animation < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :animation, TD::Types::Animation
+    attribute :title, TD::Types::String
+  end
+end

data/lib/tdlib/types/inline_query_result/article.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Represents a link to an article or web page.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr url [String] URL of the result, if it exists.
+  # @attr hide_url [Boolean] True, if the URL must be not shown.
+  # @attr title [String] Title of the result.
+  # @attr description [String] A short description of the result.
+  # @attr thumbnail [TD::Types::PhotoSize, nil] Result thumbnail; may be null.
+  class InlineQueryResult::Article < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :url, TD::Types::String
+    attribute :hide_url, TD::Types::Bool
+    attribute :title, TD::Types::String
+    attribute :description, TD::Types::String
+    attribute :thumbnail, TD::Types::PhotoSize.optional.default(nil)
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents an audio file.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr audio [TD::Types::Audio] Audio file.
+  class InlineQueryResult::Audio < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :audio, TD::Types::Audio
+  end
+end

data/lib/tdlib/types/inline_query_result/contact.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents a user contact.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr contact [TD::Types::Contact] A user contact.
+  # @attr thumbnail [TD::Types::PhotoSize, nil] Result thumbnail; may be null.
+  class InlineQueryResult::Contact < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :contact, TD::Types::Contact
+    attribute :thumbnail, TD::Types::PhotoSize.optional.default(nil)
+  end
+end

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

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents a document.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr document [TD::Types::Document] Document.
+  # @attr title [String] Document title.
+  # @attr description [String] Document description.
+  class InlineQueryResult::Document < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :document, TD::Types::Document
+    attribute :title, TD::Types::String
+    attribute :description, TD::Types::String
+  end
+end

data/lib/tdlib/types/inline_query_result/game.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents information about a game.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr game [TD::Types::Game] Game result.
+  class InlineQueryResult::Game < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :game, TD::Types::Game
+  end
+end

data/lib/tdlib/types/inline_query_result/location.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents a point on the map.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr location [TD::Types::Location] Location result.
+  # @attr title [String] Title of the result.
+  # @attr thumbnail [TD::Types::PhotoSize, nil] Result thumbnail; may be null.
+  class InlineQueryResult::Location < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :location, TD::Types::Location
+    attribute :title, TD::Types::String
+    attribute :thumbnail, TD::Types::PhotoSize.optional.default(nil)
+  end
+end

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

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents a photo.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr photo [TD::Types::Photo] Photo.
+  # @attr title [String] Title of the result, if known.
+  # @attr description [String] A short description of the result, if known.
+  class InlineQueryResult::Photo < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :photo, TD::Types::Photo
+    attribute :title, TD::Types::String
+    attribute :description, TD::Types::String
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a sticker.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr sticker [TD::Types::Sticker] Sticker.
+  class InlineQueryResult::Sticker < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :sticker, TD::Types::Sticker
+  end
+end

data/lib/tdlib/types/inline_query_result/venue.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents information about a venue.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr venue [TD::Types::Venue] Venue result.
+  # @attr thumbnail [TD::Types::PhotoSize, nil] Result thumbnail; may be null.
+  class InlineQueryResult::Venue < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :venue, TD::Types::Venue
+    attribute :thumbnail, TD::Types::PhotoSize.optional.default(nil)
+  end
+end

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

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents a video.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr video [TD::Types::Video] Video.
+  # @attr title [String] Title of the video.
+  # @attr description [String] Description of the video.
+  class InlineQueryResult::Video < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :video, TD::Types::Video
+    attribute :title, TD::Types::String
+    attribute :description, TD::Types::String
+  end
+end

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

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents a voice note.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr voice_note [TD::Types::VoiceNote] Voice note.
+  # @attr title [String] Title of the voice note.
+  class InlineQueryResult::VoiceNote < InlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :voice_note, TD::Types::VoiceNote
+    attribute :title, TD::Types::String
+  end
+end

data/lib/tdlib/types/inline_query_results.rb

@@ -0,0 +1,19 @@
+module TD::Types
+  # Represents the results of the inline query.
+  # Use sendInlineQueryResultMessage to send the result of the query.
+  #
+  # @attr inline_query_id [Integer] Unique identifier of the inline query.
+  # @attr next_offset [String] The offset for the next request.
+  #   If empty, there are no more results.
+  # @attr results [Array<TD::Types::InlineQueryResult>] Results of the query.
+  # @attr switch_pm_text [String] If non-empty, this text should be shown on the button, which opens a private chat
+  #   with the bot and sends the bot a start message with the switch_pm_parameter.
+  # @attr switch_pm_parameter [String] Parameter for the bot start message.
+  class InlineQueryResults < Base
+    attribute :inline_query_id, TD::Types::Integer
+    attribute :next_offset, TD::Types::String
+    attribute :results, TD::Types::Array.of(TD::Types::InlineQueryResult)
+    attribute :switch_pm_text, TD::Types::String
+    attribute :switch_pm_parameter, TD::Types::String
+  end
+end

data/lib/tdlib/types/input_credentials.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Contains information about the payment method chosen by the user.
+  class InputCredentials < Base
+    %w[
+      saved
+      new
+      android_pay
+      apple_pay
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/input_credentials/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/input_credentials/android_pay.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Applies if a user enters new credentials using Android Pay.
+  #
+  # @attr data [String] JSON-encoded data with the credential identifier.
+  class InputCredentials::AndroidPay < InputCredentials
+    attribute :data, TD::Types::String
+  end
+end

data/lib/tdlib/types/input_credentials/apple_pay.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Applies if a user enters new credentials using Apple Pay.
+  #
+  # @attr data [String] JSON-encoded data with the credential identifier.
+  class InputCredentials::ApplePay < InputCredentials
+    attribute :data, TD::Types::String
+  end
+end

data/lib/tdlib/types/input_credentials/new.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Applies if a user enters new credentials on a payment provider website.
+  #
+  # @attr data [String] Contains JSON-encoded data with a credential identifier from the payment provider.
+  # @attr allow_save [Boolean] True, if the credential identifier can be saved on the server side.
+  class InputCredentials::New < InputCredentials
+    attribute :data, TD::Types::String
+    attribute :allow_save, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/input_credentials/saved.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # Applies if a user chooses some previously saved payment credentials.
+  # To use their previously saved credentials, the user must have a valid temporary password.
+  #
+  # @attr saved_credentials_id [String] Identifier of the saved credentials.
+  class InputCredentials::Saved < InputCredentials
+    attribute :saved_credentials_id, TD::Types::String
+  end
+end

data/lib/tdlib/types/input_file.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Points to a file.
+  class InputFile < Base
+    %w[
+      id
+      remote
+      local
+      generated
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/input_file/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/input_file/generated.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # A file generated by the client.
+  #
+  # @attr original_path [String, nil] Local path to a file from which the file is generated; may be empty if there is
+  #   no such file.
+  # @attr conversion [String] String specifying the conversion applied to the original file; should be persistent
+  #   across application restarts.
+  # @attr expected_size [Integer] Expected size of the generated file; 0 if unknown.
+  class InputFile::Generated < InputFile
+    attribute :original_path, TD::Types::String.optional.default(nil)
+    attribute :conversion, TD::Types::String
+    attribute :expected_size, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/input_file/id.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A file defined by its unique ID.
+  #
+  # @attr id [Integer] Unique file identifier.
+  class InputFile::Id < InputFile
+    attribute :id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/input_file/local.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A file defined by a local path.
+  #
+  # @attr path [String] Local path to the file.
+  class InputFile::Local < InputFile
+    attribute :path, TD::Types::String
+  end
+end

data/lib/tdlib/types/input_file/remote.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A file defined by its remote ID.
+  #
+  # @attr id [String] Remote file identifier.
+  class InputFile::Remote < InputFile
+    attribute :id, TD::Types::String
+  end
+end

data/lib/tdlib/types/input_identity_document.rb

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

data/lib/tdlib/types/input_inline_query_result.rb

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

data/lib/tdlib/types/input_inline_query_result/animated_gif.rb

@@ -0,0 +1,26 @@
+module TD::Types
+  # Represents a link to an animated GIF.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr title [String] Title of the query result.
+  # @attr thumbnail_url [String] URL of the static result thumbnail (JPEG or GIF), if it exists.
+  # @attr gif_url [String] The URL of the GIF-file (file size must not exceed 1MB).
+  # @attr gif_duration [Integer] Duration of the GIF, in seconds.
+  # @attr gif_width [Integer] Width of the GIF.
+  # @attr gif_height [Integer] Height of the GIF.
+  # @attr reply_markup [TD::Types::ReplyMarkup::InlineKeyboard, nil] The message reply markup.
+  # @attr input_message_content [TD::Types::InputMessageContent::Text, TD::Types::InputMessageContent::Animation,
+  #   TD::Types::InputMessageContent::Location, TD::Types::InputMessageContent::Venue,
+  #   TD::Types::InputMessageContent::Contact] The content of the message to be sent.
+  class InputInlineQueryResult::AnimatedGif < InputInlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :title, TD::Types::String
+    attribute :thumbnail_url, TD::Types::String
+    attribute :gif_url, TD::Types::String
+    attribute :gif_duration, TD::Types::Integer
+    attribute :gif_width, TD::Types::Integer
+    attribute :gif_height, TD::Types::Integer
+    attribute :reply_markup, TD::Types::ReplyMarkup
+    attribute :input_message_content, TD::Types::InputMessageContent
+  end
+end

data/lib/tdlib/types/input_inline_query_result/animated_mpeg4.rb

@@ -0,0 +1,27 @@
+module TD::Types
+  # Represents a link to an animated (i.e.
+  # without sound) H.264/MPEG-4 AVC video.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr title [String] Title of the result.
+  # @attr thumbnail_url [String] URL of the static result thumbnail (JPEG or GIF), if it exists.
+  # @attr mpeg4_url [String] The URL of the MPEG4-file (file size must not exceed 1MB).
+  # @attr mpeg4_duration [Integer] Duration of the video, in seconds.
+  # @attr mpeg4_width [Integer] Width of the video.
+  # @attr mpeg4_height [Integer] Height of the video.
+  # @attr reply_markup [TD::Types::ReplyMarkup::InlineKeyboard, nil] The message reply markup.
+  # @attr input_message_content [TD::Types::InputMessageContent::Text, TD::Types::InputMessageContent::Animation,
+  #   TD::Types::InputMessageContent::Location, TD::Types::InputMessageContent::Venue,
+  #   TD::Types::InputMessageContent::Contact] The content of the message to be sent.
+  class InputInlineQueryResult::AnimatedMpeg4 < InputInlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :title, TD::Types::String
+    attribute :thumbnail_url, TD::Types::String
+    attribute :mpeg4_url, TD::Types::String
+    attribute :mpeg4_duration, TD::Types::Integer
+    attribute :mpeg4_width, TD::Types::Integer
+    attribute :mpeg4_height, TD::Types::Integer
+    attribute :reply_markup, TD::Types::ReplyMarkup
+    attribute :input_message_content, TD::Types::InputMessageContent
+  end
+end

data/lib/tdlib/types/input_inline_query_result/article.rb

@@ -0,0 +1,28 @@
+module TD::Types
+  # Represents a link to an article or web page.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr url [String] URL of the result, if it exists.
+  # @attr hide_url [Boolean] True, if the URL must be not shown.
+  # @attr title [String] Title of the result.
+  # @attr description [String] A short description of the result.
+  # @attr thumbnail_url [String] URL of the result thumbnail, if it exists.
+  # @attr thumbnail_width [Integer] Thumbnail width, if known.
+  # @attr thumbnail_height [Integer] Thumbnail height, if known.
+  # @attr reply_markup [TD::Types::ReplyMarkup::InlineKeyboard, nil] The message reply markup.
+  # @attr input_message_content [TD::Types::InputMessageContent::Text, TD::Types::InputMessageContent::Location,
+  #   TD::Types::InputMessageContent::Venue, TD::Types::InputMessageContent::Contact] The content of the message to be
+  #   sent.
+  class InputInlineQueryResult::Article < InputInlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :url, TD::Types::String
+    attribute :hide_url, TD::Types::Bool
+    attribute :title, TD::Types::String
+    attribute :description, TD::Types::String
+    attribute :thumbnail_url, TD::Types::String
+    attribute :thumbnail_width, TD::Types::Integer
+    attribute :thumbnail_height, TD::Types::Integer
+    attribute :reply_markup, TD::Types::ReplyMarkup
+    attribute :input_message_content, TD::Types::InputMessageContent
+  end
+end

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

@@ -0,0 +1,22 @@
+module TD::Types
+  # Represents a link to an MP3 audio file.
+  #
+  # @attr id [String] Unique identifier of the query result.
+  # @attr title [String] Title of the audio file.
+  # @attr performer [String] Performer of the audio file.
+  # @attr audio_url [String] The URL of the audio file.
+  # @attr audio_duration [Integer] Audio file duration, in seconds.
+  # @attr reply_markup [TD::Types::ReplyMarkup::InlineKeyboard, nil] The message reply markup.
+  # @attr input_message_content [TD::Types::InputMessageContent::Text, TD::Types::InputMessageContent::Audio,
+  #   TD::Types::InputMessageContent::Location, TD::Types::InputMessageContent::Venue,
+  #   TD::Types::InputMessageContent::Contact] The content of the message to be sent.
+  class InputInlineQueryResult::Audio < InputInlineQueryResult
+    attribute :id, TD::Types::String
+    attribute :title, TD::Types::String
+    attribute :performer, TD::Types::String
+    attribute :audio_url, TD::Types::String
+    attribute :audio_duration, TD::Types::Integer
+    attribute :reply_markup, TD::Types::ReplyMarkup
+    attribute :input_message_content, TD::Types::InputMessageContent
+  end
+end