tdlib-ruby 2.0.0 → 2.1.0

data/lib/tdlib/types/page_block/map.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # A map.
+  #
+  # @attr location [TD::Types::Location] Location of the map center.
+  # @attr zoom [Integer] Map zoom level.
+  # @attr width [Integer] Map width.
+  # @attr height [Integer] Map height.
+  # @attr caption [TD::Types::PageBlockCaption] Block caption.
+  class PageBlock::Map < PageBlock
+    attribute :location, TD::Types::Location
+    attribute :zoom, TD::Types::Integer
+    attribute :width, TD::Types::Integer
+    attribute :height, TD::Types::Integer
+    attribute :caption, TD::Types::PageBlockCaption
+  end
+end

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

@@ -2,9 +2,11 @@ module TD::Types
   # A photo.
   #
   # @attr photo [TD::Types::Photo, nil] Photo file; may be null.
-  # @attr caption [TD::Types::RichText] Photo caption.
+  # @attr caption [TD::Types::PageBlockCaption] Photo caption.
+  # @attr url [String] URL that needs to be opened when the photo is clicked.
   class PageBlock::Photo < PageBlock
     attribute :photo, TD::Types::Photo.optional.default(nil)
-    attribute :caption, TD::Types::RichText
+    attribute :caption, TD::Types::PageBlockCaption
+    attribute :url, TD::Types::String
   end
 end

data/lib/tdlib/types/page_block/pull_quote.rb

@@ -2,9 +2,9 @@ module TD::Types
   # A pull quote.
   #
   # @attr text [TD::Types::RichText] Quote text.
-  # @attr caption [TD::Types::RichText] Quote caption.
+  # @attr credit [TD::Types::RichText] Quote credit.
   class PageBlock::PullQuote < PageBlock
     attribute :text, TD::Types::RichText
-    attribute :caption, TD::Types::RichText
+    attribute :credit, TD::Types::RichText
   end
 end

data/lib/tdlib/types/page_block/related_articles.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Related articles.
+  #
+  # @attr header [TD::Types::RichText] Block header.
+  # @attr articles [Array<TD::Types::PageBlockRelatedArticle>] List of related articles.
+  class PageBlock::RelatedArticles < PageBlock
+    attribute :header, TD::Types::RichText
+    attribute :articles, TD::Types::Array.of(TD::Types::PageBlockRelatedArticle)
+  end
+end

data/lib/tdlib/types/page_block/slideshow.rb

@@ -2,9 +2,9 @@ module TD::Types
   # A slideshow.
   #
   # @attr page_blocks [Array<TD::Types::PageBlock>] Slideshow item contents.
-  # @attr caption [TD::Types::RichText] Block caption.
+  # @attr caption [TD::Types::PageBlockCaption] Block caption.
   class PageBlock::Slideshow < PageBlock
     attribute :page_blocks, TD::Types::Array.of(TD::Types::PageBlock)
-    attribute :caption, TD::Types::RichText
+    attribute :caption, TD::Types::PageBlockCaption
   end
 end

data/lib/tdlib/types/page_block/table.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # A table.
+  #
+  # @attr caption [TD::Types::RichText] Table caption.
+  # @attr cells [Array<Array<TD::Types::PageBlockTableCell>>] Table cells.
+  # @attr is_bordered [Boolean] True, if the table is bordered.
+  # @attr is_striped [Boolean] True, if the table is striped.
+  class PageBlock::Table < PageBlock
+    attribute :caption, TD::Types::RichText
+    attribute :cells, TD::Types::Array.of(TD::Types::Array.of(TD::Types::PageBlockTableCell))
+    attribute :is_bordered, TD::Types::Bool
+    attribute :is_striped, TD::Types::Bool
+  end
+end

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

@@ -2,12 +2,12 @@ module TD::Types
   # A video.
   #
   # @attr video [TD::Types::Video, nil] Video file; may be null.
-  # @attr caption [TD::Types::RichText] Video caption.
+  # @attr caption [TD::Types::PageBlockCaption] Video caption.
   # @attr need_autoplay [Boolean] True, if the video should be played automatically.
   # @attr is_looped [Boolean] True, if the video should be looped.
   class PageBlock::Video < PageBlock
     attribute :video, TD::Types::Video.optional.default(nil)
-    attribute :caption, TD::Types::RichText
+    attribute :caption, TD::Types::PageBlockCaption
     attribute :need_autoplay, TD::Types::Bool
     attribute :is_looped, TD::Types::Bool
   end

data/lib/tdlib/types/page_block_caption.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains a caption of an instant view web page block, consisting of a text and a trailing credit.
+  #
+  # @attr text [TD::Types::RichText] Content of the caption.
+  # @attr credit [TD::Types::RichText] Block credit (like HTML tag <cite>).
+  class PageBlockCaption < Base
+    attribute :text, TD::Types::RichText
+    attribute :credit, TD::Types::RichText
+  end
+end

data/lib/tdlib/types/page_block_horizontal_alignment.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Describes a horizontal alignment of a table cell content.
+  class PageBlockHorizontalAlignment < Base
+    %w[
+      left
+      center
+      right
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/page_block_horizontal_alignment/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/page_block_horizontal_alignment/center.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The content should be center-aligned.
+  class PageBlockHorizontalAlignment::Center < PageBlockHorizontalAlignment
+  end
+end

data/lib/tdlib/types/page_block_horizontal_alignment/left.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The content should be left-aligned.
+  class PageBlockHorizontalAlignment::Left < PageBlockHorizontalAlignment
+  end
+end

data/lib/tdlib/types/page_block_horizontal_alignment/right.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The content should be right-aligned.
+  class PageBlockHorizontalAlignment::Right < PageBlockHorizontalAlignment
+  end
+end

data/lib/tdlib/types/page_block_list_item.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Describes an item of a list page block.
+  #
+  # @attr label [String] Item label.
+  # @attr page_blocks [Array<TD::Types::PageBlock>] Item blocks.
+  class PageBlockListItem < Base
+    attribute :label, TD::Types::String
+    attribute :page_blocks, TD::Types::Array.of(TD::Types::PageBlock)
+  end
+end

data/lib/tdlib/types/page_block_related_article.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Contains information about a related article.
+  #
+  # @attr url [String] Related article URL.
+  # @attr title [String, nil] Article title; may be empty.
+  # @attr description [String, nil] Article description; may be empty.
+  # @attr photo [TD::Types::Photo, nil] Article photo; may be null.
+  # @attr author [String, nil] Article author; may be empty.
+  # @attr publish_date [Integer] Point in time (Unix timestamp) when the article was published; 0 if unknown.
+  class PageBlockRelatedArticle < Base
+    attribute :url, TD::Types::String
+    attribute :title, TD::Types::String.optional.default(nil)
+    attribute :description, TD::Types::String.optional.default(nil)
+    attribute :photo, TD::Types::Photo.optional.default(nil)
+    attribute :author, TD::Types::String.optional.default(nil)
+    attribute :publish_date, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/page_block_table_cell.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Represents a cell of a table.
+  #
+  # @attr text [TD::Types::RichText] Cell text.
+  # @attr is_header [Boolean] True, if it is a header cell.
+  # @attr colspan [Integer] The number of columns the cell should span.
+  # @attr rowspan [Integer] The number of rows the cell should span.
+  # @attr align [TD::Types::PageBlockHorizontalAlignment] Horizontal cell content alignment.
+  # @attr valign [TD::Types::PageBlockVerticalAlignment] Vertical cell content alignment.
+  class PageBlockTableCell < Base
+    attribute :text, TD::Types::RichText
+    attribute :is_header, TD::Types::Bool
+    attribute :colspan, TD::Types::Integer
+    attribute :rowspan, TD::Types::Integer
+    attribute :align, TD::Types::PageBlockHorizontalAlignment
+    attribute :valign, TD::Types::PageBlockVerticalAlignment
+  end
+end

data/lib/tdlib/types/page_block_vertical_alignment.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Describes a Vertical alignment of a table cell content.
+  class PageBlockVerticalAlignment < Base
+    %w[
+      top
+      middle
+      bottom
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/page_block_vertical_alignment/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/page_block_vertical_alignment/bottom.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The content should be bottom-aligned.
+  class PageBlockVerticalAlignment::Bottom < PageBlockVerticalAlignment
+  end
+end

data/lib/tdlib/types/page_block_vertical_alignment/middle.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The content should be middle-aligned.
+  class PageBlockVerticalAlignment::Middle < PageBlockVerticalAlignment
+  end
+end

data/lib/tdlib/types/page_block_vertical_alignment/top.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The content should be top-aligned.
+  class PageBlockVerticalAlignment::Top < PageBlockVerticalAlignment
+  end
+end

data/lib/tdlib/types/passport_authorization_form.rb

@@ -4,14 +4,10 @@ module TD::Types
   # @attr id [Integer] Unique identifier of the authorization form.
   # @attr required_elements [Array<TD::Types::PassportRequiredElement>] Information about the Telegram Passport
   #   elements that need to be provided to complete the form.
-  # @attr elements [Array<TD::Types::PassportElement>] Already available Telegram Passport elements.
-  # @attr errors [Array<TD::Types::PassportElementError>] Errors in the elements that are already available.
-  # @attr privacy_policy_url [String, nil] URL for the privacy policy of the service; can be empty.
+  # @attr privacy_policy_url [String, nil] URL for the privacy policy of the service; may be empty.
   class PassportAuthorizationForm < Base
     attribute :id, TD::Types::Integer
     attribute :required_elements, TD::Types::Array.of(TD::Types::PassportRequiredElement)
-    attribute :elements, TD::Types::Array.of(TD::Types::PassportElement)
-    attribute :errors, TD::Types::Array.of(TD::Types::PassportElementError)
     attribute :privacy_policy_url, TD::Types::String.optional.default(nil)
   end
 end

data/lib/tdlib/types/passport_element_error_source/file.rb

@@ -1,6 +1,9 @@
 module TD::Types
   # The file contains an error.
   # The error will be considered resolved when the file changes.
+  #
+  # @attr file_index [Integer] Index of a file with the error.
   class PassportElementErrorSource::File < PassportElementErrorSource
+    attribute :file_index, TD::Types::Integer
   end
 end

data/lib/tdlib/types/passport_element_error_source/translation_file.rb

@@ -1,6 +1,9 @@
 module TD::Types
   # One of files with the translation of the document contains an error.
   # The error will be considered resolved when the file changes.
+  #
+  # @attr file_index [Integer] Index of a file with the error.
   class PassportElementErrorSource::TranslationFile < PassportElementErrorSource
+    attribute :file_index, TD::Types::Integer
   end
 end

data/lib/tdlib/types/passport_elements_with_errors.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains information about a Telegram Passport elements and corresponding errors.
+  #
+  # @attr elements [Array<TD::Types::PassportElement>] Telegram Passport elements.
+  # @attr errors [Array<TD::Types::PassportElementError>] Errors in the elements that are already available.
+  class PassportElementsWithErrors < Base
+    attribute :elements, TD::Types::Array.of(TD::Types::PassportElement)
+    attribute :errors, TD::Types::Array.of(TD::Types::PassportElementError)
+  end
+end

data/lib/tdlib/types/password_state.rb

@@ -1,17 +1,17 @@
 module TD::Types
   # Represents the current state of 2-step verification.
   #
-  # @attr has_password [Boolean] True if a 2-step verification password is set.
-  # @attr password_hint [String, nil] Hint for the password; can be empty.
-  # @attr has_recovery_email_address [Boolean] True if a recovery email is set.
-  # @attr has_passport_data [Boolean] True if some Telegram Passport elements were saved.
-  # @attr unconfirmed_recovery_email_address_pattern [String] Pattern of the email address to which the confirmation
-  #   email was sent.
+  # @attr has_password [Boolean] True, if a 2-step verification password is set.
+  # @attr password_hint [String, nil] Hint for the password; may be empty.
+  # @attr has_recovery_email_address [Boolean] True, if a recovery email is set.
+  # @attr has_passport_data [Boolean] True, if some Telegram Passport elements were saved.
+  # @attr recovery_email_address_code_info [TD::Types::EmailAddressAuthenticationCodeInfo, nil] Information about the
+  #   recovery email address to which the confirmation email was sent; may be null.
   class PasswordState < Base
     attribute :has_password, TD::Types::Bool
     attribute :password_hint, TD::Types::String.optional.default(nil)
     attribute :has_recovery_email_address, TD::Types::Bool
     attribute :has_passport_data, TD::Types::Bool
-    attribute :unconfirmed_recovery_email_address_pattern, TD::Types::String
+    attribute :recovery_email_address_code_info, TD::Types::EmailAddressAuthenticationCodeInfo.optional.default(nil)
   end
 end

data/lib/tdlib/types/phone_number_authentication_settings.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Contains settings for the authentication of the user's phone number.
+  #
+  # @attr allow_flash_call [Boolean] Pass true if the authentication code may be sent via flash call to the specified
+  #   phone number.
+  # @attr is_current_phone_number [Boolean] Pass true if the authenticated phone number is used on the current device.
+  # @attr allow_sms_retriever_api [Boolean] For official applications only.
+  #   True, if the app can use Android SMS Retriever API (requires Google Play Services >= 10.2) to automatically
+  #   receive the authentication code from the SMS.
+  #   See https://developers.google.com/identity/sms-retriever/ for more details.
+  class PhoneNumberAuthenticationSettings < Base
+    attribute :allow_flash_call, TD::Types::Bool
+    attribute :is_current_phone_number, TD::Types::Bool
+    attribute :allow_sms_retriever_api, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/photo.rb

@@ -1,12 +1,12 @@
 module TD::Types
   # Describes a photo.
   #
-  # @attr id [Integer] Photo identifier; 0 for deleted photos.
   # @attr has_stickers [Boolean] True, if stickers were added to the photo.
+  # @attr minithumbnail [TD::Types::Minithumbnail, nil] Photo minithumbnail; may be null.
   # @attr sizes [Array<TD::Types::PhotoSize>] Available variants of the photo, in different sizes.
   class Photo < Base
-    attribute :id, TD::Types::Integer
     attribute :has_stickers, TD::Types::Bool
+    attribute :minithumbnail, TD::Types::Minithumbnail.optional.default(nil)
     attribute :sizes, TD::Types::Array.of(TD::Types::PhotoSize)
   end
 end

data/lib/tdlib/types/poll.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Describes a poll.
+  #
+  # @attr id [Integer] Unique poll identifier.
+  # @attr question [String] Poll question, 1-255 characters.
+  # @attr options [Array<TD::Types::PollOption>] List of poll answer options.
+  # @attr total_voter_count [Integer] Total number of voters, participating in the poll.
+  # @attr is_closed [Boolean] True, if the poll is closed.
+  class Poll < Base
+    attribute :id, TD::Types::Integer
+    attribute :question, TD::Types::String
+    attribute :options, TD::Types::Array.of(TD::Types::PollOption)
+    attribute :total_voter_count, TD::Types::Integer
+    attribute :is_closed, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/poll_option.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Describes one answer option of a poll.
+  #
+  # @attr text [String] Option text, 1-100 characters.
+  # @attr voter_count [Integer] Number of voters for this option, available only for closed or voted polls.
+  # @attr vote_percentage [Integer] The percentage of votes for this option, 0-100.
+  # @attr is_chosen [Boolean] True, if the option was chosen by the user.
+  # @attr is_being_chosen [Boolean] True, if the option is being chosen by a pending setPollAnswer request.
+  class PollOption < Base
+    attribute :text, TD::Types::String
+    attribute :voter_count, TD::Types::Integer
+    attribute :vote_percentage, TD::Types::Integer
+    attribute :is_chosen, TD::Types::Bool
+    attribute :is_being_chosen, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/profile_photo.rb

@@ -4,7 +4,9 @@ module TD::Types
   # @attr id [Integer] Photo identifier; 0 for an empty photo.
   #   Can be used to find a photo in a list of userProfilePhotos.
   # @attr small [TD::Types::File] A small (160x160) user profile photo.
+  #   The file can be downloaded only before the photo is changed.
   # @attr big [TD::Types::File] A big (640x640) user profile photo.
+  #   The file can be downloaded only before the photo is changed.
   class ProfilePhoto < Base
     attribute :id, TD::Types::Integer
     attribute :small, TD::Types::File

data/lib/tdlib/types/public_message_link.rb

@@ -1,5 +1,5 @@
 module TD::Types
-  # Contains a public HTTPS link to a message in a public supergroup or channel.
+  # Contains a public HTTPS link to a message in a public supergroup or channel with a username.
   #
   # @attr link [String] Message link.
   # @attr html [String] HTML-code for embedding the message.

data/lib/tdlib/types/push_message_content.rb

@@ -0,0 +1,35 @@
+module TD::Types
+  # Contains content of a push message notification.
+  class PushMessageContent < Base
+    %w[
+      hidden
+      animation
+      audio
+      contact
+      contact_registered
+      document
+      game
+      game_score
+      invoice
+      location
+      photo
+      poll
+      screenshot_taken
+      sticker
+      text
+      video
+      video_note
+      voice_note
+      basic_group_chat_create
+      chat_add_members
+      chat_change_photo
+      chat_change_title
+      chat_delete_member
+      chat_join_by_link
+      message_forwards
+      media_album
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/push_message_content/#{type}"
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module TD::Types
+  # An animation message (GIF-style)..
+  #
+  # @attr animation [TD::Types::Animation, nil] Message content; may be null.
+  # @attr caption [String] Animation caption.
+  # @attr is_pinned [Boolean] True, if the message is a pinned message with the specified content.
+  class PushMessageContent::Animation < PushMessageContent
+    attribute :animation, TD::Types::Animation.optional.default(nil)
+    attribute :caption, TD::Types::String
+    attribute :is_pinned, TD::Types::Bool
+  end
+end