tdlib-ruby 2.1.0 → 2.2.0

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

@@ -3,7 +3,7 @@ module TD::Types
   #
   # @attr is_blurred [Boolean] True, if the wallpaper must be downscaled to fit in 450x450 square and then box-blurred
   #   with radius 12.
-  # @attr is_moving [Boolean] True, if the background needs to be slightly moved when device is rotated.
+  # @attr is_moving [Boolean] True, if the background needs to be slightly moved when device is tilted.
   class BackgroundType::Wallpaper < BackgroundType
     attribute :is_blurred, TD::Types::Bool
     attribute :is_moving, TD::Types::Bool

data/lib/tdlib/types/base.rb

@@ -1,7 +1,7 @@
 module TD::Types
   class Base < Dry::Struct
     # throw an error when unknown keys provided
-    input input.strict
+    schema schema.strict
     
     # convert string keys to symbols
     transform_keys(&:to_sym)

data/lib/tdlib/types/basic_group_full_info.rb

@@ -4,8 +4,8 @@ module TD::Types
   # @attr description [String] Group description.
   # @attr creator_user_id [Integer] User identifier of the creator of the group; 0 if unknown.
   # @attr members [Array<TD::Types::ChatMember>] Group members.
-  # @attr invite_link [String] Invite link for this group; available only for the group creator and only after it has
-  #   been generated at least once.
+  # @attr invite_link [String] Invite link for this group; available only after it has been generated at least once and
+  #   only for the group creator.
   class BasicGroupFullInfo < Base
     attribute :description, TD::Types::String
     attribute :creator_user_id, TD::Types::Integer

data/lib/tdlib/types/call_protocol.rb

@@ -3,8 +3,8 @@ module TD::Types
   #
   # @attr udp_p2p [Boolean] True, if UDP peer-to-peer connections are supported.
   # @attr udp_reflector [Boolean] True, if connection through UDP reflectors is supported.
-  # @attr min_layer [Integer] Minimum supported API layer; use 65.
-  # @attr max_layer [Integer] Maximum supported API layer; use 65.
+  # @attr min_layer [Integer] The minimum supported API layer; use 65.
+  # @attr max_layer [Integer] The maximum supported API layer; use 65.
   class CallProtocol < Base
     attribute :udp_p2p, TD::Types::Bool
     attribute :udp_reflector, TD::Types::Bool

data/lib/tdlib/types/can_transfer_ownership_result.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Represents result of checking whether the current session can be used to transfer a chat ownership to another user.
+  class CanTransferOwnershipResult < Base
+    %w[
+      ok
+      password_needed
+      password_too_fresh
+      session_too_fresh
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/can_transfer_ownership_result/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/can_transfer_ownership_result/ok.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The session can be used.
+  class CanTransferOwnershipResult::Ok < CanTransferOwnershipResult
+  end
+end

data/lib/tdlib/types/can_transfer_ownership_result/password_needed.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The 2-step verification needs to be enabled first.
+  class CanTransferOwnershipResult::PasswordNeeded < CanTransferOwnershipResult
+  end
+end

data/lib/tdlib/types/can_transfer_ownership_result/password_too_fresh.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The 2-step verification was enabled recently, user needs to wait.
+  #
+  # @attr retry_after [Integer] Time left before the session can be used to transfer ownership of a chat, in seconds.
+  class CanTransferOwnershipResult::PasswordTooFresh < CanTransferOwnershipResult
+    attribute :retry_after, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/can_transfer_ownership_result/session_too_fresh.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The session was created recently, user needs to wait.
+  #
+  # @attr retry_after [Integer] Time left before the session can be used to transfer ownership of a chat, in seconds.
+  class CanTransferOwnershipResult::SessionTooFresh < CanTransferOwnershipResult
+    attribute :retry_after, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat.rb

@@ -4,6 +4,7 @@ module TD::Types
   #
   # @attr id [Integer] Chat unique identifier.
   # @attr type [TD::Types::ChatType] Type of the chat.
+  # @attr chat_list [TD::Types::ChatList, nil] A chat list to which the chat belongs; may be null.
   # @attr title [String] Chat title.
   # @attr photo [TD::Types::ChatPhoto, nil] Chat photo; may be null.
   # @attr permissions [TD::Types::ChatPermissions] Actions that non-administrator chat members are allowed to take in
@@ -15,6 +16,7 @@ module TD::Types
   # @attr is_pinned [Boolean] True, if the chat is pinned.
   # @attr is_marked_as_unread [Boolean] True, if the chat is marked as unread.
   # @attr is_sponsored [Boolean] True, if the chat is sponsored by the user's MTProxy server.
+  # @attr has_scheduled_messages [Boolean] True, if the chat has scheduled messages.
   # @attr can_be_deleted_only_for_self [Boolean] True, if the chat messages can be deleted only for the current user
   #   while other users will continue to see the messages.
   # @attr can_be_deleted_for_all_users [Boolean] True, if the chat messages can be deleted for all users.
@@ -26,16 +28,19 @@ module TD::Types
   # @attr last_read_outbox_message_id [Integer] Identifier of the last read outgoing message.
   # @attr unread_mention_count [Integer] Number of unread messages with a mention/reply in the chat.
   # @attr notification_settings [TD::Types::ChatNotificationSettings] Notification settings for this chat.
+  # @attr action_bar [TD::Types::ChatActionBar, nil] Describes actions which should be possible to do through a chat
+  #   action bar; may be null.
   # @attr pinned_message_id [Integer] Identifier of the pinned message in the chat; 0 if none.
   # @attr reply_markup_message_id [Integer] Identifier of the message from which reply markup needs to be used; 0 if
   #   there is no default custom reply markup in the chat.
   # @attr draft_message [TD::Types::DraftMessage, nil] A draft of a message in the chat; may be null.
   # @attr client_data [String] Contains client-specific data associated with the chat.
-  #   (For example, the chat position or local chat notification settings can be stored here.) Persistent if a message
-  #   database is used.
+  #   (For example, the chat position or local chat notification settings can be stored here.) Persistent if the
+  #   message database is used.
   class Chat < Base
     attribute :id, TD::Types::Integer
     attribute :type, TD::Types::ChatType
+    attribute :chat_list, TD::Types::ChatList.optional.default(nil)
     attribute :title, TD::Types::String
     attribute :photo, TD::Types::ChatPhoto.optional.default(nil)
     attribute :permissions, TD::Types::ChatPermissions
@@ -44,6 +49,7 @@ module TD::Types
     attribute :is_pinned, TD::Types::Bool
     attribute :is_marked_as_unread, TD::Types::Bool
     attribute :is_sponsored, TD::Types::Bool
+    attribute :has_scheduled_messages, TD::Types::Bool
     attribute :can_be_deleted_only_for_self, TD::Types::Bool
     attribute :can_be_deleted_for_all_users, TD::Types::Bool
     attribute :can_be_reported, TD::Types::Bool
@@ -53,6 +59,7 @@ module TD::Types
     attribute :last_read_outbox_message_id, TD::Types::Integer
     attribute :unread_mention_count, TD::Types::Integer
     attribute :notification_settings, TD::Types::ChatNotificationSettings
+    attribute :action_bar, TD::Types::ChatActionBar.optional.default(nil)
     attribute :pinned_message_id, TD::Types::Integer
     attribute :reply_markup_message_id, TD::Types::Integer
     attribute :draft_message, TD::Types::DraftMessage.optional.default(nil)

data/lib/tdlib/types/chat_action_bar.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Describes actions which should be possible to do through a chat action bar.
+  class ChatActionBar < Base
+    %w[
+      report_spam
+      report_unrelated_location
+      report_add_block
+      add_contact
+      share_phone_number
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/chat_action_bar/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/chat_action_bar/add_contact.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # The chat is a private or secret chat and the other user can be added to the contact list using the method
+  #   addContact.
+  class ChatActionBar::AddContact < ChatActionBar
+  end
+end

data/lib/tdlib/types/chat_action_bar/report_add_block.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be
+  #   added to the contact list using the method addContact, or the other user can be blocked using the method blockUser.
+  class ChatActionBar::ReportAddBlock < ChatActionBar
+  end
+end

data/lib/tdlib/types/chat_action_bar/report_spam.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The chat can be reported as spam using the method reportChat with the reason chatReportReasonSpam.
+  class ChatActionBar::ReportSpam < ChatActionBar
+  end
+end

data/lib/tdlib/types/chat_action_bar/report_unrelated_location.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # The chat is a location-based supergroup, which can be reported as having unrelated location using the method
+  #   reportChat with the reason chatReportReasonUnrelatedLocation.
+  class ChatActionBar::ReportUnrelatedLocation < ChatActionBar
+  end
+end

data/lib/tdlib/types/chat_action_bar/share_phone_number.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # The chat is a private or secret chat with a mutual contact and the user's phone number can be shared with the other
+  #   user using the method sharePhoneNumber.
+  class ChatActionBar::SharePhoneNumber < ChatActionBar
+  end
+end

data/lib/tdlib/types/chat_administrator.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains information about a chat administrator.
+  #
+  # @attr user_id [Integer] User identifier of the administrator.
+  # @attr custom_title [String] Custom title of the administrator.
+  # @attr is_owner [Boolean] True, if the user is the owner of the chat.
+  class ChatAdministrator < Base
+    attribute :user_id, TD::Types::Integer
+    attribute :custom_title, TD::Types::String
+    attribute :is_owner, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/chat_administrators.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a list of chat administrators.
+  #
+  # @attr administrators [Array<TD::Types::ChatAdministrator>] A list of chat administrators.
+  class ChatAdministrators < Base
+    attribute :administrators, TD::Types::Array.of(TD::Types::ChatAdministrator)
+  end
+end

data/lib/tdlib/types/chat_event_action.rb

@@ -18,8 +18,11 @@ module TD::Types
       username_changed
       photo_changed
       invites_toggled
+      linked_chat_changed
+      slow_mode_delay_changed
       sign_messages_toggled
       sticker_set_changed
+      location_changed
       is_all_history_available_toggled
     ].each do |type|
       autoload TD::Types.camelize(type), "tdlib/types/chat_event_action/#{type}"

data/lib/tdlib/types/chat_event_action/linked_chat_changed.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # The linked chat of a supergroup was changed.
+  #
+  # @attr old_linked_chat_id [Integer] Previous supergroup linked chat identifier.
+  # @attr new_linked_chat_id [Integer] New supergroup linked chat identifier.
+  class ChatEventAction::LinkedChatChanged < ChatEventAction
+    attribute :old_linked_chat_id, TD::Types::Integer
+    attribute :new_linked_chat_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_event_action/location_changed.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # The supergroup location was changed.
+  #
+  # @attr old_location [TD::Types::ChatLocation, nil] Previous location; may be null.
+  # @attr new_location [TD::Types::ChatLocation, nil] New location; may be null.
+  class ChatEventAction::LocationChanged < ChatEventAction
+    attribute :old_location, TD::Types::ChatLocation.optional.default(nil)
+    attribute :new_location, TD::Types::ChatLocation.optional.default(nil)
+  end
+end

data/lib/tdlib/types/chat_event_action/slow_mode_delay_changed.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # The slow_mode_delay setting of a supergroup was changed.
+  #
+  # @attr old_slow_mode_delay [Integer] Previous value of slow_mode_delay.
+  # @attr new_slow_mode_delay [Integer] New value of slow_mode_delay.
+  class ChatEventAction::SlowModeDelayChanged < ChatEventAction
+    attribute :old_slow_mode_delay, TD::Types::Integer
+    attribute :new_slow_mode_delay, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_invite_link_info.rb

@@ -7,7 +7,8 @@ module TD::Types
   # @attr photo [TD::Types::ChatPhoto, nil] Chat photo; may be null.
   # @attr member_count [Integer] Number of members.
   # @attr member_user_ids [Array<Integer>] User identifiers of some chat members that may be known to the current user.
-  # @attr is_public [Boolean] True, if the chat is a public supergroup or a channel with a username.
+  # @attr is_public [Boolean] True, if the chat is a public supergroup or channel, i.e.
+  #   it has a username or it is a location-based supergroup.
   class ChatInviteLinkInfo < Base
     attribute :chat_id, TD::Types::Integer
     attribute :type, TD::Types::ChatType

data/lib/tdlib/types/chat_list.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes a list of chats.
+  class ChatList < Base
+    %w[
+      main
+      archive
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/chat_list/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/chat_list/archive.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # A list of chats usually located at the top of the main chat list.
+  # Unmuted chats are automatically moved from the Archive to the Main chat list when a new message arrives.
+  class ChatList::Archive < ChatList
+  end
+end

data/lib/tdlib/types/chat_list/main.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A main list of chats.
+  class ChatList::Main < ChatList
+  end
+end

data/lib/tdlib/types/chat_location.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a location to which a chat is connected.
+  #
+  # @attr location [TD::Types::Location] The location.
+  # @attr address [String] Location address; 1-64 characters, as defined by the chat owner.
+  class ChatLocation < Base
+    attribute :location, TD::Types::Location
+    attribute :address, TD::Types::String
+  end
+end

data/lib/tdlib/types/chat_member_status/administrator.rb

@@ -4,6 +4,8 @@ module TD::Types
   #   members.
   # In supergroups and channels, there are more detailed options for administrator privileges.
   #
+  # @attr custom_title [String] A custom title of the administrator; 0-16 characters without emojis; applicable to
+  #   supergroups only.
   # @attr can_be_edited [Boolean] True, if the current user can edit the administrator privileges for the called user.
   # @attr can_change_info [Boolean] True, if the administrator can change the chat title, photo, and other settings.
   # @attr can_post_messages [Boolean] True, if the administrator can create channel posts; applicable to channels only.
@@ -14,8 +16,9 @@ module TD::Types
   # @attr can_restrict_members [Boolean] True, if the administrator can restrict, ban, or unban chat members.
   # @attr can_pin_messages [Boolean] True, if the administrator can pin messages; applicable to groups only.
   # @attr can_promote_members [Boolean] True, if the administrator can add new administrators with a subset of their
-  #   own privileges or demote administrators that were directly or indirectly promoted by him.
+  #   own privileges or demote administrators that were directly or indirectly promoted by them.
   class ChatMemberStatus::Administrator < ChatMemberStatus
+    attribute :custom_title, TD::Types::String
     attribute :can_be_edited, TD::Types::Bool
     attribute :can_change_info, TD::Types::Bool
     attribute :can_post_messages, TD::Types::Bool

data/lib/tdlib/types/chat_member_status/creator.rb

@@ -1,8 +1,11 @@
 module TD::Types
-  # The user is the creator of a chat and has all the administrator privileges.
+  # The user is the owner of a chat and has all the administrator privileges.
   #
+  # @attr custom_title [String] A custom title of the owner; 0-16 characters without emojis; applicable to supergroups
+  #   only.
   # @attr is_member [Boolean] True, if the user is a member of the chat.
   class ChatMemberStatus::Creator < ChatMemberStatus
+    attribute :custom_title, TD::Types::String
     attribute :is_member, TD::Types::Bool
   end
 end

data/lib/tdlib/types/chat_members_filter/administrators.rb

@@ -1,5 +1,5 @@
 module TD::Types
-  # Returns the creator and administrators.
+  # Returns the owner and administrators.
   class ChatMembersFilter::Administrators < ChatMembersFilter
   end
 end

data/lib/tdlib/types/chat_nearby.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Describes a chat located nearby.
+  #
+  # @attr chat_id [Integer] Chat identifier.
+  # @attr distance [Integer] Distance to the chat location in meters.
+  class ChatNearby < Base
+    attribute :chat_id, TD::Types::Integer
+    attribute :distance, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_report_reason.rb

@@ -7,6 +7,7 @@ module TD::Types
       pornography
       child_abuse
       copyright
+      unrelated_location
       custom
     ].each do |type|
       autoload TD::Types.camelize(type), "tdlib/types/chat_report_reason/#{type}"

data/lib/tdlib/types/chat_report_reason/unrelated_location.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The location-based chat is unrelated to its stated location.
+  class ChatReportReason::UnrelatedLocation < ChatReportReason
+  end
+end

data/lib/tdlib/types/chats_nearby.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a list of chats located nearby.
+  #
+  # @attr users_nearby [Array<TD::Types::ChatNearby>] List of users nearby.
+  # @attr supergroups_nearby [Array<TD::Types::ChatNearby>] List of location-based supergroups nearby.
+  class ChatsNearby < Base
+    attribute :users_nearby, TD::Types::Array.of(TD::Types::ChatNearby)
+    attribute :supergroups_nearby, TD::Types::Array.of(TD::Types::ChatNearby)
+  end
+end

data/lib/tdlib/types/formatted_text.rb

@@ -3,6 +3,10 @@ module TD::Types
   #
   # @attr text [String] The text.
   # @attr entities [Array<TD::Types::TextEntity>] Entities contained in the text.
+  #   Entities can be nested, but must not mutually intersect with each other.
+  #   Pre, Code and PreCode entities can't contain other entities.
+  #   Bold, Italic, Underline and Strikethrough entities can contain and to be contained in all other entities.
+  #   All other entities can't contain each other.
   class FormattedText < Base
     attribute :text, TD::Types::String
     attribute :entities, TD::Types::Array.of(TD::Types::TextEntity)

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

@@ -1,7 +1,7 @@
 module TD::Types
   # A button that opens a specified URL and automatically logs in in current user if they allowed to do that.
   #
-  # @attr url [String] HTTP URL to open.
+  # @attr url [String] An HTTP URL to open.
   # @attr id [Integer] Unique button identifier.
   # @attr forward_text [String] If non-empty, new text of the button in forwarded messages.
   class InlineKeyboardButtonType::LoginUrl < InlineKeyboardButtonType

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

@@ -1,5 +1,9 @@
 module TD::Types
   # A file defined by its remote ID.
+  # The remote ID is guaranteed to be usable only if the corresponding file is still accessible to the user and known
+  #   to TDLib.
+  # For example, if the file is from a message, then the message must be not deleted and accessible to the user.
+  # If the file database is disabled, then the corresponding object with the file must be preloaded by the client.
   #
   # @attr id [String] Remote file identifier.
   class InputFile::Remote < InputFile

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

@@ -1,9 +1,9 @@
 module TD::Types
-  # Represents a link to a WEBP or a TGS sticker.
+  # Represents a link to a WEBP or TGS sticker.
   #
   # @attr id [String] Unique identifier of the query result.
   # @attr thumbnail_url [String] URL of the sticker thumbnail, if it exists.
-  # @attr sticker_url [String] The URL of the WEBP or a TGS sticker (sticker file size must not exceed 5MB).
+  # @attr sticker_url [String] The URL of the WEBP or TGS sticker (sticker file size must not exceed 5MB).
   # @attr sticker_width [Integer] Width of the sticker.
   # @attr sticker_height [Integer] Height of the sticker.
   # @attr reply_markup [TD::Types::ReplyMarkup] The message reply markup.