tdlib-schema 1.7.0.1

data/lib/tdlib/types/supergroup_full_info.rb

@@ -0,0 +1,56 @@
+module TD::Types
+  # Contains full information about a supergroup or channel.
+  #
+  # @attr photo [TD::Types::ChatPhoto, nil] Chat photo; may be null.
+  # @attr description [String] Supergroup or channel description.
+  # @attr member_count [Integer] Number of members in the supergroup or channel; 0 if unknown.
+  # @attr administrator_count [Integer] Number of privileged users in the supergroup or channel; 0 if unknown.
+  # @attr restricted_count [Integer] Number of restricted users in the supergroup; 0 if unknown.
+  # @attr banned_count [Integer] Number of users banned from chat; 0 if unknown.
+  # @attr linked_chat_id [Integer] Chat identifier of a discussion group for the channel, or a channel, for which the
+  #   supergroup is the designated discussion group; 0 if none or unknown.
+  # @attr slow_mode_delay [Integer] Delay between consecutive sent messages for non-administrator supergroup members,
+  #   in seconds.
+  # @attr slow_mode_delay_expires_in [Float] Time left before next message can be sent in the supergroup, in seconds.
+  #   An {TD::Types::Update::SupergroupFullInfo} update is not triggered when value of this field changes, but both new
+  #   and old values are non-zero.
+  # @attr can_get_members [Boolean] True, if members of the chat can be retrieved.
+  # @attr can_set_username [Boolean] True, if the chat username can be changed.
+  # @attr can_set_sticker_set [Boolean] True, if the supergroup sticker set can be changed.
+  # @attr can_set_location [Boolean] True, if the supergroup location can be changed.
+  # @attr can_get_statistics [Boolean] True, if the supergroup or channel statistics are available.
+  # @attr is_all_history_available [Boolean] True, if new chat members will have access to old messages.
+  #   In public or discussion groups and both public and private channels, old messages are always available, so this
+  #   option affects only private supergroups without a linked chat.
+  #   The value of this field is only available for chat administrators.
+  # @attr sticker_set_id [Integer] Identifier of the supergroup sticker set; 0 if none.
+  # @attr location [TD::Types::ChatLocation, nil] Location to which the supergroup is connected; may be null.
+  # @attr invite_link [TD::Types::ChatInviteLink, nil] Primary invite link for this chat; may be null.
+  #   For chat administrators with can_invite_users right only.
+  # @attr upgraded_from_basic_group_id [Integer] Identifier of the basic group from which supergroup was upgraded; 0 if
+  #   none.
+  # @attr upgraded_from_max_message_id [Integer] Identifier of the last message in the basic group from which
+  #   supergroup was upgraded; 0 if none.
+  class SupergroupFullInfo < Base
+    attribute :photo, TD::Types::ChatPhoto.optional.default(nil)
+    attribute :description, TD::Types::String
+    attribute :member_count, TD::Types::Integer
+    attribute :administrator_count, TD::Types::Integer
+    attribute :restricted_count, TD::Types::Integer
+    attribute :banned_count, TD::Types::Integer
+    attribute :linked_chat_id, TD::Types::Integer
+    attribute :slow_mode_delay, TD::Types::Integer
+    attribute :slow_mode_delay_expires_in, TD::Types::Float
+    attribute :can_get_members, TD::Types::Bool
+    attribute :can_set_username, TD::Types::Bool
+    attribute :can_set_sticker_set, TD::Types::Bool
+    attribute :can_set_location, TD::Types::Bool
+    attribute :can_get_statistics, TD::Types::Bool
+    attribute :is_all_history_available, TD::Types::Bool
+    attribute :sticker_set_id, TD::Types::Integer
+    attribute :location, TD::Types::ChatLocation.optional.default(nil)
+    attribute :invite_link, TD::Types::ChatInviteLink.optional.default(nil)
+    attribute :upgraded_from_basic_group_id, TD::Types::Integer
+    attribute :upgraded_from_max_message_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/supergroup_members_filter.rb

@@ -0,0 +1,17 @@
+module TD::Types
+  # Specifies the kind of chat members to return in getSupergroupMembers.
+  class SupergroupMembersFilter < Base
+    %w[
+      recent
+      contacts
+      administrators
+      search
+      restricted
+      banned
+      mention
+      bots
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/supergroup_members_filter/#{type}"
+    end
+  end
+end

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

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

data/lib/tdlib/types/supergroup_members_filter/banned.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Returns users banned from the supergroup or channel; can be used only by administrators.
+  #
+  # @attr query [String] Query to search for.
+  class SupergroupMembersFilter::Banned < SupergroupMembersFilter
+    attribute :query, TD::Types::String
+  end
+end

data/lib/tdlib/types/supergroup_members_filter/bots.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # Returns bot members of the supergroup or channel.
+  class SupergroupMembersFilter::Bots < SupergroupMembersFilter
+  end
+end

data/lib/tdlib/types/supergroup_members_filter/contacts.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Returns contacts of the user, which are members of the supergroup or channel.
+  #
+  # @attr query [String] Query to search for.
+  class SupergroupMembersFilter::Contacts < SupergroupMembersFilter
+    attribute :query, TD::Types::String
+  end
+end

data/lib/tdlib/types/supergroup_members_filter/mention.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Returns users which can be mentioned in the supergroup.
+  #
+  # @attr query [String] Query to search for.
+  # @attr message_thread_id [Integer] If non-zero, the identifier of the current message thread.
+  class SupergroupMembersFilter::Mention < SupergroupMembersFilter
+    attribute :query, TD::Types::String
+    attribute :message_thread_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/supergroup_members_filter/recent.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # Returns recently active users in reverse chronological order.
+  class SupergroupMembersFilter::Recent < SupergroupMembersFilter
+  end
+end

data/lib/tdlib/types/supergroup_members_filter/restricted.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Returns restricted supergroup members; can be used only by administrators.
+  #
+  # @attr query [String] Query to search for.
+  class SupergroupMembersFilter::Restricted < SupergroupMembersFilter
+    attribute :query, TD::Types::String
+  end
+end

data/lib/tdlib/types/supergroup_members_filter/search.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Used to search for supergroup or channel members via a (string) query.
+  #
+  # @attr query [String] Query to search for.
+  class SupergroupMembersFilter::Search < SupergroupMembersFilter
+    attribute :query, TD::Types::String
+  end
+end

data/lib/tdlib/types/t_me_url.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a URL linking to an internal Telegram entity.
+  #
+  # @attr url [String] URL.
+  # @attr type [TD::Types::TMeUrlType] Type of the URL.
+  class TMeUrl < Base
+    attribute :url, TD::Types::String
+    attribute :type, TD::Types::TMeUrlType
+  end
+end

data/lib/tdlib/types/t_me_url_type.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Describes the type of a URL linking to an internal Telegram entity.
+  class TMeUrlType < Base
+    %w[
+      user
+      supergroup
+      chat_invite
+      sticker_set
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/t_me_url_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/t_me_url_type/chat_invite.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A chat invite link.
+  #
+  # @attr info [TD::Types::ChatInviteLinkInfo] Chat invite link info.
+  class TMeUrlType::ChatInvite < TMeUrlType
+    attribute :info, TD::Types::ChatInviteLinkInfo
+  end
+end

data/lib/tdlib/types/t_me_url_type/sticker_set.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A URL linking to a sticker set.
+  #
+  # @attr sticker_set_id [Integer] Identifier of the sticker set.
+  class TMeUrlType::StickerSet < TMeUrlType
+    attribute :sticker_set_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/t_me_url_type/supergroup.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A URL linking to a public supergroup or channel.
+  #
+  # @attr supergroup_id [Integer] Identifier of the supergroup or channel.
+  class TMeUrlType::Supergroup < TMeUrlType
+    attribute :supergroup_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/t_me_url_type/user.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A URL linking to a user.
+  #
+  # @attr user_id [Integer] Identifier of the user.
+  class TMeUrlType::User < TMeUrlType
+    attribute :user_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/t_me_urls.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of t.me URLs.
+  #
+  # @attr urls [Array<TD::Types::TMeUrl>] List of URLs.
+  class TMeUrls < Base
+    attribute :urls, TD::Types::Array.of(TD::Types::TMeUrl)
+  end
+end

data/lib/tdlib/types/tdlib_parameters.rb

@@ -0,0 +1,47 @@
+module TD::Types
+  # Contains parameters for TDLib initialization.
+  #
+  # @attr use_test_dc [Boolean, nil] If set to true, the Telegram test environment will be used instead of the
+  #   production environment.
+  # @attr database_directory [String, nil] The path to the directory for the persistent database; if empty, the current
+  #   working directory will be used.
+  # @attr files_directory [String, nil] The path to the directory for storing files; if empty, database_directory will
+  #   be used.
+  # @attr use_file_database [Boolean, nil] If set to true, information about downloaded and uploaded files will be
+  #   saved between application restarts.
+  # @attr use_chat_info_database [Boolean, nil] If set to true, the library will maintain a cache of users, basic
+  #   groups, supergroups, channels and secret chats.
+  #   Implies use_file_database.
+  # @attr use_message_database [Boolean, nil] If set to true, the library will maintain a cache of chats and messages.
+  #   Implies use_chat_info_database.
+  # @attr use_secret_chats [Boolean, nil] If set to true, support for secret chats will be enabled.
+  # @attr api_id [Integer, nil] Application identifier for Telegram API access, which can be obtained at
+  #   https://my.telegram.org.
+  # @attr api_hash [String, nil] Application identifier hash for Telegram API access, which can be obtained at
+  #   https://my.telegram.org.
+  # @attr system_language_code [String] IETF language tag of the user's operating system language; must be non-empty.
+  # @attr device_model [String] Model of the device the application is being run on; must be non-empty.
+  # @attr system_version [String, nil] Version of the operating system the application is being run on.
+  #   If empty, the version is automatically detected by TDLib.
+  # @attr application_version [String] Application version; must be non-empty.
+  # @attr enable_storage_optimizer [Boolean, nil] If set to true, old files will automatically be deleted.
+  # @attr ignore_file_names [Boolean, nil] If set to true, original file names will be ignored.
+  #   Otherwise, downloaded files will be saved under names as close as possible to the original name.
+  class TdlibParameters < Base
+    attribute :use_test_dc, TD::Types::Bool.optional.default(nil)
+    attribute :database_directory, TD::Types::String.optional.default(nil)
+    attribute :files_directory, TD::Types::String.optional.default(nil)
+    attribute :use_file_database, TD::Types::Bool.optional.default(nil)
+    attribute :use_chat_info_database, TD::Types::Bool.optional.default(nil)
+    attribute :use_message_database, TD::Types::Bool.optional.default(nil)
+    attribute :use_secret_chats, TD::Types::Bool.optional.default(nil)
+    attribute :api_id, TD::Types::Integer.optional.default(nil)
+    attribute :api_hash, TD::Types::String.optional.default(nil)
+    attribute :system_language_code, TD::Types::String
+    attribute :device_model, TD::Types::String
+    attribute :system_version, TD::Types::String.optional.default(nil)
+    attribute :application_version, TD::Types::String
+    attribute :enable_storage_optimizer, TD::Types::Bool.optional.default(nil)
+    attribute :ignore_file_names, TD::Types::Bool.optional.default(nil)
+  end
+end

data/lib/tdlib/types/temporary_password_state.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Returns information about the availability of a temporary password, which can be used for payments.
+  #
+  # @attr has_password [Boolean] True, if a temporary password is available.
+  # @attr valid_for [Integer] Time left before the temporary password expires, in seconds.
+  class TemporaryPasswordState < Base
+    attribute :has_password, TD::Types::Bool
+    attribute :valid_for, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/terms_of_service.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains Telegram terms of service.
+  #
+  # @attr text [TD::Types::FormattedText] Text of the terms of service.
+  # @attr min_user_age [Integer] The minimum age of a user to be able to accept the terms; 0 if any.
+  # @attr show_popup [Boolean] True, if a blocking popup with terms of service must be shown to the user.
+  class TermsOfService < Base
+    attribute :text, TD::Types::FormattedText
+    attribute :min_user_age, TD::Types::Integer
+    attribute :show_popup, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/text.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains some text.
+  #
+  # @attr text [String] Text.
+  class Text < Base
+    attribute :text, TD::Types::String
+  end
+end

data/lib/tdlib/types/text_entities.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of text entities.
+  #
+  # @attr entities [Array<TD::Types::TextEntity>] List of text entities.
+  class TextEntities < Base
+    attribute :entities, TD::Types::Array.of(TD::Types::TextEntity)
+  end
+end

data/lib/tdlib/types/text_entity.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents a part of the text that needs to be formatted in some unusual way.
+  #
+  # @attr offset [Integer] Offset of the entity, in UTF-16 code units.
+  # @attr length [Integer] Length of the entity, in UTF-16 code units.
+  # @attr type [TD::Types::TextEntityType] Type of the entity.
+  class TextEntity < Base
+    attribute :offset, TD::Types::Integer
+    attribute :length, TD::Types::Integer
+    attribute :type, TD::Types::TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type.rb

@@ -0,0 +1,26 @@
+module TD::Types
+  # Represents a part of the text which must be formatted differently.
+  class TextEntityType < Base
+    %w[
+      mention
+      hashtag
+      cashtag
+      bot_command
+      url
+      email_address
+      phone_number
+      bank_card_number
+      bold
+      italic
+      underline
+      strikethrough
+      code
+      pre
+      pre_code
+      text_url
+      mention_name
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/text_entity_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/text_entity_type/bank_card_number.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # A bank card number.
+  # The getBankCardInfo method can be used to get information about the bank card.
+  class TextEntityType::BankCardNumber < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/bold.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A bold text.
+  class TextEntityType::Bold < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/bot_command.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # A bot command, beginning with "/".
+  # This shouldn't be highlighted if there are no bots in the chat.
+  class TextEntityType::BotCommand < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/cashtag.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # A cashtag text, beginning with "$" and consisting of capital english letters (i.e.
+  # "$USD").
+  class TextEntityType::Cashtag < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/code.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # Text that must be formatted as if inside a code HTML tag.
+  class TextEntityType::Code < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/email_address.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # An email address.
+  class TextEntityType::EmailAddress < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/hashtag.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A hashtag text, beginning with "#".
+  class TextEntityType::Hashtag < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/italic.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # An italic text.
+  class TextEntityType::Italic < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/mention.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A mention of a user by their username.
+  class TextEntityType::Mention < TextEntityType
+  end
+end

data/lib/tdlib/types/text_entity_type/mention_name.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A text shows instead of a raw mention of the user (e.g., when the user has no username).
+  #
+  # @attr user_id [Integer] Identifier of the mentioned user.
+  class TextEntityType::MentionName < TextEntityType
+    attribute :user_id, TD::Types::Integer
+  end
+end