tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/sticker_set_info.rb

@@ -0,0 +1,29 @@
+module TD::Types
+  # Represents short information about a sticker set.
+  #
+  # @attr id [Integer] Identifier of the sticker set.
+  # @attr title [String] Title of the sticker set.
+  # @attr name [String] Name of the sticker set.
+  # @attr is_installed [Boolean] True, if the sticker set has been installed by current user.
+  # @attr is_archived [Boolean] True, if the sticker set has been archived.
+  #   A sticker set can't be installed and archived simultaneously.
+  # @attr is_official [Boolean] True, if the sticker set is official.
+  # @attr is_masks [Boolean] True, if the stickers in the set are masks.
+  # @attr is_viewed [Boolean] True for already viewed trending sticker sets.
+  # @attr size [Integer] Total number of stickers in the set.
+  # @attr covers [Array<TD::Types::Sticker>] Contains up to the first 5 stickers from the set, depending on the
+  #   context.
+  #   If the client needs more stickers the full set should be requested.
+  class StickerSetInfo < Base
+    attribute :id, TD::Types::Integer
+    attribute :title, TD::Types::String
+    attribute :name, TD::Types::String
+    attribute :is_installed, TD::Types::Bool
+    attribute :is_archived, TD::Types::Bool
+    attribute :is_official, TD::Types::Bool
+    attribute :is_masks, TD::Types::Bool
+    attribute :is_viewed, TD::Types::Bool
+    attribute :size, TD::Types::Integer
+    attribute :covers, TD::Types::Array.of(TD::Types::Sticker)
+  end
+end

data/lib/tdlib/types/sticker_sets.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a list of sticker sets.
+  #
+  # @attr total_count [Integer] Approximate total number of sticker sets found.
+  # @attr sets [Array<TD::Types::StickerSetInfo>] List of sticker sets.
+  class StickerSets < Base
+    attribute :total_count, TD::Types::Integer
+    attribute :sets, TD::Types::Array.of(TD::Types::StickerSetInfo)
+  end
+end

data/lib/tdlib/types/stickers.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a list of stickers.
+  #
+  # @attr stickers [Array<TD::Types::Sticker>] List of stickers.
+  class Stickers < Base
+    attribute :stickers, TD::Types::Array.of(TD::Types::Sticker)
+  end
+end

data/lib/tdlib/types/storage_statistics.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains the exact storage usage statistics split by chats and file type.
+  #
+  # @attr size [Integer] Total size of files.
+  # @attr count [Integer] Total number of files.
+  # @attr by_chat [Array<TD::Types::StorageStatisticsByChat>] Statistics split by chats.
+  class StorageStatistics < Base
+    attribute :size, TD::Types::Integer
+    attribute :count, TD::Types::Integer
+    attribute :by_chat, TD::Types::Array.of(TD::Types::StorageStatisticsByChat)
+  end
+end

data/lib/tdlib/types/storage_statistics_by_chat.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Contains the storage usage statistics for a specific chat.
+  #
+  # @attr chat_id [Integer] Chat identifier; 0 if none.
+  # @attr size [Integer] Total size of the files in the chat.
+  # @attr count [Integer] Total number of files in the chat.
+  # @attr by_file_type [Array<TD::Types::StorageStatisticsByFileType>] Statistics split by file types.
+  class StorageStatisticsByChat < Base
+    attribute :chat_id, TD::Types::Integer
+    attribute :size, TD::Types::Integer
+    attribute :count, TD::Types::Integer
+    attribute :by_file_type, TD::Types::Array.of(TD::Types::StorageStatisticsByFileType)
+  end
+end

data/lib/tdlib/types/storage_statistics_by_file_type.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains the storage usage statistics for a specific file type.
+  #
+  # @attr file_type [TD::Types::FileType] File type.
+  # @attr size [Integer] Total size of the files.
+  # @attr count [Integer] Total number of files.
+  class StorageStatisticsByFileType < Base
+    attribute :file_type, TD::Types::FileType
+    attribute :size, TD::Types::Integer
+    attribute :count, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/storage_statistics_fast.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains approximate storage usage statistics, excluding files of unknown file type.
+  #
+  # @attr files_size [Integer] Approximate total size of files.
+  # @attr file_count [Integer] Approximate number of files.
+  # @attr database_size [Integer] Size of the database.
+  class StorageStatisticsFast < Base
+    attribute :files_size, TD::Types::Integer
+    attribute :file_count, TD::Types::Integer
+    attribute :database_size, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/supergroup.rb

@@ -0,0 +1,40 @@
+module TD::Types
+  # Represents a supergroup or channel with zero or more members (subscribers in the case of channels).
+  # From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and
+  #   see the list of members, and posts from all administrators use the name and photo of the channel instead of individual
+  #   names and profile photos.
+  # Unlike supergroups, channels can have an unlimited number of subscribers.
+  #
+  # @attr id [Integer] Supergroup or channel identifier.
+  # @attr username [String, nil] Username of the supergroup or channel; empty for private supergroups or channels.
+  # @attr date [Integer] Point in time (Unix timestamp) when the current user joined, or the point in time when the
+  #   supergroup or channel was created, in case the user is not a member.
+  # @attr status [TD::Types::ChatMemberStatus] Status of the current user in the supergroup or channel.
+  # @attr member_count [Integer] Member count; 0 if unknown.
+  #   Currently it is guaranteed to be known only if the supergroup or channel was found through SearchPublicChats.
+  # @attr anyone_can_invite [Boolean] True, if any member of the supergroup can invite other members.
+  #   This field has no meaning for channels.
+  # @attr sign_messages [Boolean] True, if messages sent to the channel should contain information about the sender.
+  #   This field is only applicable to channels.
+  # @attr is_channel [Boolean] True, if the supergroup is a channel.
+  # @attr is_verified [Boolean] True, if the supergroup or channel is verified.
+  # @attr restriction_reason [String] If non-empty, contains the reason why access to this supergroup or channel must
+  #   be restricted.
+  #   Format of the string is "{type}: {description}".
+  #   {type} Contains the type of the restriction and at least one of the suffixes "-all", "-ios", "-android", or
+  #   "-wp", which describe the platforms on which access should be restricted.
+  #   (For example, "terms-ios-android".
+  #   {description} contains a human-readable description of the restriction, which can be shown to the user).
+  class Supergroup < Base
+    attribute :id, TD::Types::Integer
+    attribute :username, TD::Types::String.optional.default(nil)
+    attribute :date, TD::Types::Integer
+    attribute :status, TD::Types::ChatMemberStatus
+    attribute :member_count, TD::Types::Integer
+    attribute :anyone_can_invite, TD::Types::Bool
+    attribute :sign_messages, TD::Types::Bool
+    attribute :is_channel, TD::Types::Bool
+    attribute :is_verified, TD::Types::Bool
+    attribute :restriction_reason, TD::Types::String
+  end
+end

data/lib/tdlib/types/supergroup_full_info.rb

@@ -0,0 +1,39 @@
+module TD::Types
+  # Contains full information about a supergroup or channel.
+  #
+  # @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 can_get_members [Boolean] True, if members of the chat can be retrieved.
+  # @attr can_set_username [Boolean] True, if the chat can be made public.
+  # @attr can_set_sticker_set [Boolean] True, if the supergroup sticker set can be changed.
+  # @attr is_all_history_available [Boolean] True, if new chat members will have access to old messages.
+  #   In public supergroups and both public and private channels, old messages are always available, so this option
+  #   affects only private supergroups.
+  #   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 invite_link [String] Invite link for this chat.
+  # @attr pinned_message_id [Integer] Identifier of the pinned message in the chat; 0 if none.
+  # @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 :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 :can_get_members, TD::Types::Bool
+    attribute :can_set_username, TD::Types::Bool
+    attribute :can_set_sticker_set, TD::Types::Bool
+    attribute :is_all_history_available, TD::Types::Bool
+    attribute :sticker_set_id, TD::Types::Integer
+    attribute :invite_link, TD::Types::String
+    attribute :pinned_message_id, TD::Types::Integer
+    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,15 @@
+module TD::Types
+  # Specifies the kind of chat members to return in getSupergroupMembers.
+  class SupergroupMembersFilter < Base
+    %w[
+      recent
+      administrators
+      search
+      restricted
+      banned
+      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 creator 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/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,46 @@
+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] Version of the operating system the application is being run on; must be non-empty.
+  # @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
+    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] Mininum 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 points.
+  # @attr length [Integer] Length of the entity, in UTF-16 code points.
+  # @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,23 @@
+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
+      bold
+      italic
+      code
+      pre
+      pre_code
+      text_url
+      mention_name
+      phone_number
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/text_entity_type/#{type}"
+    end
+  end
+end