tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/update/saved_animations.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The list of saved animations was updated.
+  #
+  # @attr animation_ids [Array<Integer>] The new list of file identifiers of saved animations.
+  class Update::SavedAnimations < Update
+    attribute :animation_ids, TD::Types::Array.of(TD::Types::Integer)
+  end
+end

data/lib/tdlib/types/update/scope_notification_settings.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Notification settings for some type of chats were updated.
+  #
+  # @attr scope [TD::Types::NotificationSettingsScope] Types of chats for which notification settings were updated.
+  # @attr notification_settings [TD::Types::ScopeNotificationSettings] The new notification settings.
+  class Update::ScopeNotificationSettings < Update
+    attribute :scope, TD::Types::NotificationSettingsScope
+    attribute :notification_settings, TD::Types::ScopeNotificationSettings
+  end
+end

data/lib/tdlib/types/update/secret_chat.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # Some data of a secret chat has changed.
+  # This update is guaranteed to come before the secret chat identifier is returned to the client.
+  #
+  # @attr secret_chat [TD::Types::SecretChat] New data about the secret chat.
+  class Update::SecretChat < Update
+    attribute :secret_chat, TD::Types::SecretChat
+  end
+end

data/lib/tdlib/types/update/service_notification.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Service notification from the server.
+  # Upon receiving this the client must show a popup with the content of the notification.
+  #
+  # @attr type [String] Notification type.
+  #   If type begins with "AUTH_KEY_DROP_", then two buttons "Cancel" and "Log out" should be shown under notification;
+  #   if user presses the second, all local data should be destroyed using Destroy method.
+  # @attr content [TD::Types::MessageContent] Notification content.
+  class Update::ServiceNotification < Update
+    attribute :type, TD::Types::String
+    attribute :content, TD::Types::MessageContent
+  end
+end

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

@@ -0,0 +1,9 @@
+module TD::Types
+  # Some data of a supergroup or a channel has changed.
+  # This update is guaranteed to come before the supergroup identifier is returned to the client.
+  #
+  # @attr supergroup [TD::Types::Supergroup] New data about the supergroup.
+  class Update::Supergroup < Update
+    attribute :supergroup, TD::Types::Supergroup
+  end
+end

data/lib/tdlib/types/update/supergroup_full_info.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Some data from supergroupFullInfo has been changed.
+  #
+  # @attr supergroup_id [Integer] Identifier of the supergroup or channel.
+  # @attr supergroup_full_info [TD::Types::SupergroupFullInfo] New full information about the supergroup.
+  class Update::SupergroupFullInfo < Update
+    attribute :supergroup_id, TD::Types::Integer
+    attribute :supergroup_full_info, TD::Types::SupergroupFullInfo
+  end
+end

data/lib/tdlib/types/update/terms_of_service.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # New terms of service must be accepted by the user.
+  # If the terms of service are declined, then the deleteAccount method should be called with the reason "Decline ToS
+  #   update".
+  #
+  # @attr terms_of_service_id [String] Identifier of the terms of service.
+  # @attr terms_of_service [TD::Types::TermsOfService] The new terms of service.
+  class Update::TermsOfService < Update
+    attribute :terms_of_service_id, TD::Types::String
+    attribute :terms_of_service, TD::Types::TermsOfService
+  end
+end

data/lib/tdlib/types/update/trending_sticker_sets.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The list of trending sticker sets was updated or some of them were viewed.
+  #
+  # @attr sticker_sets [TD::Types::StickerSets] The new list of trending sticker sets.
+  class Update::TrendingStickerSets < Update
+    attribute :sticker_sets, TD::Types::StickerSets
+  end
+end

data/lib/tdlib/types/update/unread_chat_count.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Number of unread chats, i.e.
+  # with unread messages or marked as unread, has changed.
+  # This update is sent only if a message database is used.
+  #
+  # @attr unread_count [Integer] Total number of unread chats.
+  # @attr unread_unmuted_count [Integer] Total number of unread unmuted chats.
+  # @attr marked_as_unread_count [Integer] Total number of chats marked as unread.
+  # @attr marked_as_unread_unmuted_count [Integer] Total number of unmuted chats marked as unread.
+  class Update::UnreadChatCount < Update
+    attribute :unread_count, TD::Types::Integer
+    attribute :unread_unmuted_count, TD::Types::Integer
+    attribute :marked_as_unread_count, TD::Types::Integer
+    attribute :marked_as_unread_unmuted_count, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/update/unread_message_count.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Number of unread messages has changed.
+  # This update is sent only if a message database is used.
+  #
+  # @attr unread_count [Integer] Total number of unread messages.
+  # @attr unread_unmuted_count [Integer] Total number of unread messages in unmuted chats.
+  class Update::UnreadMessageCount < Update
+    attribute :unread_count, TD::Types::Integer
+    attribute :unread_unmuted_count, TD::Types::Integer
+  end
+end

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

@@ -0,0 +1,9 @@
+module TD::Types
+  # Some data of a user has changed.
+  # This update is guaranteed to come before the user identifier is returned to the client.
+  #
+  # @attr user [TD::Types::User] New data about the user.
+  class Update::User < Update
+    attribute :user, TD::Types::User
+  end
+end

data/lib/tdlib/types/update/user_chat_action.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # User activity in the chat has changed.
+  #
+  # @attr chat_id [Integer] Chat identifier.
+  # @attr user_id [Integer] Identifier of a user performing an action.
+  # @attr action [TD::Types::ChatAction] The action description.
+  class Update::UserChatAction < Update
+    attribute :chat_id, TD::Types::Integer
+    attribute :user_id, TD::Types::Integer
+    attribute :action, TD::Types::ChatAction
+  end
+end

data/lib/tdlib/types/update/user_full_info.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Some data from userFullInfo has been changed.
+  #
+  # @attr user_id [Integer] User identifier.
+  # @attr user_full_info [TD::Types::UserFullInfo] New full information about the user.
+  class Update::UserFullInfo < Update
+    attribute :user_id, TD::Types::Integer
+    attribute :user_full_info, TD::Types::UserFullInfo
+  end
+end

data/lib/tdlib/types/update/user_privacy_setting_rules.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Some privacy setting rules have been changed.
+  #
+  # @attr setting [TD::Types::UserPrivacySetting] The privacy setting.
+  # @attr rules [TD::Types::UserPrivacySettingRules] New privacy rules.
+  class Update::UserPrivacySettingRules < Update
+    attribute :setting, TD::Types::UserPrivacySetting
+    attribute :rules, TD::Types::UserPrivacySettingRules
+  end
+end

data/lib/tdlib/types/update/user_status.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # The user went online or offline.
+  #
+  # @attr user_id [Integer] User identifier.
+  # @attr status [TD::Types::UserStatus] New status of the user.
+  class Update::UserStatus < Update
+    attribute :user_id, TD::Types::Integer
+    attribute :status, TD::Types::UserStatus
+  end
+end

data/lib/tdlib/types/user.rb

@@ -0,0 +1,41 @@
+module TD::Types
+  # Represents a user.
+  #
+  # @attr id [Integer] User identifier.
+  # @attr first_name [String] First name of the user.
+  # @attr last_name [String] Last name of the user.
+  # @attr username [String] Username of the user.
+  # @attr phone_number [String] Phone number of the user.
+  # @attr status [TD::Types::UserStatus] Current online status of the user.
+  # @attr profile_photo [TD::Types::ProfilePhoto, nil] Profile photo of the user; may be null.
+  # @attr outgoing_link [TD::Types::LinkState] Relationship from the current user to the other user.
+  # @attr incoming_link [TD::Types::LinkState] Relationship from the other user to the current user.
+  # @attr is_verified [Boolean] True, if the user is verified.
+  # @attr restriction_reason [String] If non-empty, it contains the reason why access to this user must be restricted.
+  #   The 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).
+  # @attr have_access [Boolean] If false, the user is inaccessible, and the only information known about the user is
+  #   inside this class.
+  #   It can't be passed to any method except GetUser.
+  # @attr type [TD::Types::UserType] Type of the user.
+  # @attr language_code [String] IETF language tag of the user's language; only available to bots.
+  class User < Base
+    attribute :id, TD::Types::Integer
+    attribute :first_name, TD::Types::String
+    attribute :last_name, TD::Types::String
+    attribute :username, TD::Types::String
+    attribute :phone_number, TD::Types::String
+    attribute :status, TD::Types::UserStatus
+    attribute :profile_photo, TD::Types::ProfilePhoto.optional.default(nil)
+    attribute :outgoing_link, TD::Types::LinkState
+    attribute :incoming_link, TD::Types::LinkState
+    attribute :is_verified, TD::Types::Bool
+    attribute :restriction_reason, TD::Types::String
+    attribute :have_access, TD::Types::Bool
+    attribute :type, TD::Types::UserType
+    attribute :language_code, TD::Types::String
+  end
+end

data/lib/tdlib/types/user_full_info.rb

@@ -0,0 +1,21 @@
+module TD::Types
+  # Contains full information about a user (except the full list of profile photos).
+  #
+  # @attr is_blocked [Boolean] True, if the user is blacklisted by the current user.
+  # @attr can_be_called [Boolean] True, if the user can be called.
+  # @attr has_private_calls [Boolean] True, if the user can't be called due to their privacy settings.
+  # @attr bio [String] A short user bio.
+  # @attr share_text [String] For bots, the text that is included with the link when users share the bot.
+  # @attr group_in_common_count [Integer] Number of group chats where both the other user and the current user are a
+  #   member; 0 for the current user.
+  # @attr bot_info [TD::Types::BotInfo, nil] If the user is a bot, information about the bot; may be null.
+  class UserFullInfo < Base
+    attribute :is_blocked, TD::Types::Bool
+    attribute :can_be_called, TD::Types::Bool
+    attribute :has_private_calls, TD::Types::Bool
+    attribute :bio, TD::Types::String
+    attribute :share_text, TD::Types::String
+    attribute :group_in_common_count, TD::Types::Integer
+    attribute :bot_info, TD::Types::BotInfo.optional.default(nil)
+  end
+end

data/lib/tdlib/types/user_privacy_setting.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Describes available user privacy settings.
+  class UserPrivacySetting < Base
+    %w[
+      show_status
+      allow_chat_invites
+      allow_calls
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/user_privacy_setting/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/user_privacy_setting/allow_calls.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A privacy setting for managing whether the user can be called.
+  class UserPrivacySetting::AllowCalls < UserPrivacySetting
+  end
+end

data/lib/tdlib/types/user_privacy_setting/allow_chat_invites.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A privacy setting for managing whether the user can be invited to chats.
+  class UserPrivacySetting::AllowChatInvites < UserPrivacySetting
+  end
+end

data/lib/tdlib/types/user_privacy_setting/show_status.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A privacy setting for managing whether the user's online status is visible.
+  class UserPrivacySetting::ShowStatus < UserPrivacySetting
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rule.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Represents a single rule for managing privacy settings.
+  class UserPrivacySettingRule < Base
+    %w[
+      allow_all
+      allow_contacts
+      allow_users
+      restrict_all
+      restrict_contacts
+      restrict_users
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/user_privacy_setting_rule/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rule/allow_all.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A rule to allow all users to do something.
+  class UserPrivacySettingRule::AllowAll < UserPrivacySettingRule
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rule/allow_contacts.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A rule to allow all of a user's contacts to do something.
+  class UserPrivacySettingRule::AllowContacts < UserPrivacySettingRule
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rule/allow_users.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A rule to allow certain specified users to do something.
+  #
+  # @attr user_ids [Array<Integer>] The user identifiers.
+  class UserPrivacySettingRule::AllowUsers < UserPrivacySettingRule
+    attribute :user_ids, TD::Types::Array.of(TD::Types::Integer)
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rule/restrict_all.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A rule to restrict all users from doing something.
+  class UserPrivacySettingRule::RestrictAll < UserPrivacySettingRule
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rule/restrict_contacts.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A rule to restrict all contacts of a user from doing something.
+  class UserPrivacySettingRule::RestrictContacts < UserPrivacySettingRule
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rule/restrict_users.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A rule to restrict all specified users from doing something.
+  #
+  # @attr user_ids [Array<Integer>] The user identifiers.
+  class UserPrivacySettingRule::RestrictUsers < UserPrivacySettingRule
+    attribute :user_ids, TD::Types::Array.of(TD::Types::Integer)
+  end
+end

data/lib/tdlib/types/user_privacy_setting_rules.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # A list of privacy rules.
+  # Rules are matched in the specified order.
+  # The first matched rule defines the privacy setting for a given user.
+  # If no rule matches, the action is not allowed.
+  #
+  # @attr rules [Array<TD::Types::UserPrivacySettingRule>] A list of rules.
+  class UserPrivacySettingRules < Base
+    attribute :rules, TD::Types::Array.of(TD::Types::UserPrivacySettingRule)
+  end
+end

data/lib/tdlib/types/user_profile_photos.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains part of the list of user photos.
+  #
+  # @attr total_count [Integer] Total number of user profile photos.
+  # @attr photos [Array<TD::Types::Photo>] A list of photos.
+  class UserProfilePhotos < Base
+    attribute :total_count, TD::Types::Integer
+    attribute :photos, TD::Types::Array.of(TD::Types::Photo)
+  end
+end

data/lib/tdlib/types/user_status.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Describes the last time the user was online.
+  class UserStatus < Base
+    %w[
+      empty
+      online
+      offline
+      recently
+      last_week
+      last_month
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/user_status/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/user_status/empty.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user status was never changed.
+  class UserStatus::Empty < UserStatus
+  end
+end

data/lib/tdlib/types/user_status/last_month.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is offline, but was online last month.
+  class UserStatus::LastMonth < UserStatus
+  end
+end

data/lib/tdlib/types/user_status/last_week.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is offline, but was online last week.
+  class UserStatus::LastWeek < UserStatus
+  end
+end

data/lib/tdlib/types/user_status/offline.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The user is offline.
+  #
+  # @attr was_online [Integer] Point in time (Unix timestamp) when the user was last online.
+  class UserStatus::Offline < UserStatus
+    attribute :was_online, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/user_status/online.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The user is online.
+  #
+  # @attr expires [Integer] Point in time (Unix timestamp) when the user's online status will expire.
+  class UserStatus::Online < UserStatus
+    attribute :expires, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/user_status/recently.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user was online recently.
+  class UserStatus::Recently < UserStatus
+  end
+end

data/lib/tdlib/types/user_type.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents the type of the user.
+  # The following types are possible: regular users, deleted users and bots.
+  class UserType < Base
+    %w[
+      regular
+      deleted
+      bot
+      unknown
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/user_type/#{type}"
+    end
+  end
+end