tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/call_protocol.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Specifies the supported call protocols.
+  #
+  # @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.
+  class CallProtocol < Base
+    attribute :udp_p2p, TD::Types::Bool
+    attribute :udp_reflector, TD::Types::Bool
+    attribute :min_layer, TD::Types::Integer
+    attribute :max_layer, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/call_state.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Describes the current call state.
+  class CallState < Base
+    %w[
+      pending
+      exchanging_keys
+      ready
+      hanging_up
+      discarded
+      error
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/call_state/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/call_state/discarded.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # The call has ended successfully.
+  #
+  # @attr reason [TD::Types::CallDiscardReason] The reason, why the call has ended.
+  # @attr need_rating [Boolean] True, if the call rating should be sent to the server.
+  # @attr need_debug_information [Boolean] True, if the call debug information should be sent to the server.
+  class CallState::Discarded < CallState
+    attribute :reason, TD::Types::CallDiscardReason
+    attribute :need_rating, TD::Types::Bool
+    attribute :need_debug_information, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/call_state/error.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # The call has ended with an error.
+  #
+  # @attr error [TD::Types::Error] Error.
+  #   An error with the code 4005000 will be returned if an outgoing call is missed because of an expired timeout.
+  class CallState::Error < CallState
+    attribute :error, TD::Types::Error
+  end
+end

data/lib/tdlib/types/call_state/exchanging_keys.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The call has been answered and encryption keys are being exchanged.
+  class CallState::ExchangingKeys < CallState
+  end
+end

data/lib/tdlib/types/call_state/hanging_up.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The call is hanging up after discardCall has been called.
+  class CallState::HangingUp < CallState
+  end
+end

data/lib/tdlib/types/call_state/pending.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # The call is pending, waiting to be accepted by a user.
+  #
+  # @attr is_created [Boolean] True, if the call has already been created by the server.
+  # @attr is_received [Boolean] True, if the call has already been received by the other party.
+  class CallState::Pending < CallState
+    attribute :is_created, TD::Types::Bool
+    attribute :is_received, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/call_state/ready.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # The call is ready to use.
+  #
+  # @attr protocol [TD::Types::CallProtocol] Call protocols supported by the peer.
+  # @attr connections [Array<TD::Types::CallConnection>] Available UDP reflectors.
+  # @attr config [String] A JSON-encoded call config.
+  # @attr encryption_key [String] Call encryption key.
+  # @attr emojis [Array<String>] Encryption key emojis fingerprint.
+  class CallState::Ready < CallState
+    attribute :protocol, TD::Types::CallProtocol
+    attribute :connections, TD::Types::Array.of(TD::Types::CallConnection)
+    attribute :config, TD::Types::String
+    attribute :encryption_key, TD::Types::String
+    attribute :emojis, TD::Types::Array.of(TD::Types::String)
+  end
+end

data/lib/tdlib/types/callback_query_answer.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains a bot's answer to a callback query.
+  #
+  # @attr text [String] Text of the answer.
+  # @attr show_alert [Boolean] True, if an alert should be shown to the user instead of a toast notification.
+  # @attr url [String] URL to be opened.
+  class CallbackQueryAnswer < Base
+    attribute :text, TD::Types::String
+    attribute :show_alert, TD::Types::Bool
+    attribute :url, TD::Types::String
+  end
+end

data/lib/tdlib/types/callback_query_payload.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Represents a payload of a callback query.
+  class CallbackQueryPayload < Base
+    %w[
+      data
+      game
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/callback_query_payload/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/callback_query_payload/data.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The payload from a general callback button.
+  #
+  # @attr data [String] Data that was attached to the callback button.
+  class CallbackQueryPayload::Data < CallbackQueryPayload
+    attribute :data, TD::Types::String
+  end
+end

data/lib/tdlib/types/callback_query_payload/game.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The payload from a game callback button.
+  #
+  # @attr game_short_name [String] A short name of the game that was attached to the callback button.
+  class CallbackQueryPayload::Game < CallbackQueryPayload
+    attribute :game_short_name, TD::Types::String
+  end
+end

data/lib/tdlib/types/chat.rb

@@ -0,0 +1,51 @@
+module TD::Types
+  # A chat.
+  # (Can be a private chat, basic group, supergroup, or secret chat).
+  #
+  # @attr id [Integer] Chat unique identifier.
+  # @attr type [TD::Types::ChatType] Type of the chat.
+  # @attr title [String] Chat title.
+  # @attr photo [TD::Types::ChatPhoto, nil] Chat photo; may be null.
+  # @attr last_message [TD::Types::Message, nil] Last message in the chat; may be null.
+  # @attr order [Integer] Descending parameter by which chats are sorted in the main chat list.
+  #   If the order number of two chats is the same, they must be sorted in descending order by ID.
+  #   If 0, the position of the chat in the list is undetermined.
+  # @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 can_be_reported [Boolean] True, if the chat can be reported to Telegram moderators through reportChat.
+  # @attr default_disable_notification [Boolean] Default value of the disable_notification parameter, used when a
+  #   message is sent to the chat.
+  # @attr unread_count [Integer] Number of unread messages in the chat.
+  # @attr last_read_inbox_message_id [Integer] Identifier of the last read incoming message.
+  # @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 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.
+  class Chat < Base
+    attribute :id, TD::Types::Integer
+    attribute :type, TD::Types::ChatType
+    attribute :title, TD::Types::String
+    attribute :photo, TD::Types::ChatPhoto.optional.default(nil)
+    attribute :last_message, TD::Types::Message.optional.default(nil)
+    attribute :order, TD::Types::Integer
+    attribute :is_pinned, TD::Types::Bool
+    attribute :is_marked_as_unread, TD::Types::Bool
+    attribute :is_sponsored, TD::Types::Bool
+    attribute :can_be_reported, TD::Types::Bool
+    attribute :default_disable_notification, TD::Types::Bool
+    attribute :unread_count, TD::Types::Integer
+    attribute :last_read_inbox_message_id, TD::Types::Integer
+    attribute :last_read_outbox_message_id, TD::Types::Integer
+    attribute :unread_mention_count, TD::Types::Integer
+    attribute :notification_settings, TD::Types::ChatNotificationSettings
+    attribute :reply_markup_message_id, TD::Types::Integer
+    attribute :draft_message, TD::Types::DraftMessage.optional.default(nil)
+    attribute :client_data, TD::Types::String
+  end
+end

data/lib/tdlib/types/chat_action.rb

@@ -0,0 +1,22 @@
+module TD::Types
+  # Describes the different types of activity in a chat.
+  class ChatAction < Base
+    %w[
+      typing
+      recording_video
+      uploading_video
+      recording_voice_note
+      uploading_voice_note
+      uploading_photo
+      uploading_document
+      choosing_location
+      choosing_contact
+      start_playing_game
+      recording_video_note
+      uploading_video_note
+      cancel
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/chat_action/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/chat_action/cancel.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user has cancelled the previous action.
+  class ChatAction::Cancel < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/choosing_contact.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is picking a contact to send.
+  class ChatAction::ChoosingContact < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/choosing_location.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is picking a location or venue to send.
+  class ChatAction::ChoosingLocation < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/recording_video.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is recording a video.
+  class ChatAction::RecordingVideo < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/recording_video_note.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is recording a video note.
+  class ChatAction::RecordingVideoNote < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/recording_voice_note.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is recording a voice note.
+  class ChatAction::RecordingVoiceNote < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/start_playing_game.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user has started to play a game.
+  class ChatAction::StartPlayingGame < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/typing.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is typing a message.
+  class ChatAction::Typing < ChatAction
+  end
+end

data/lib/tdlib/types/chat_action/uploading_document.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The user is uploading a document.
+  #
+  # @attr progress [Integer] Upload progress, as a percentage.
+  class ChatAction::UploadingDocument < ChatAction
+    attribute :progress, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_action/uploading_photo.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The user is uploading a photo.
+  #
+  # @attr progress [Integer] Upload progress, as a percentage.
+  class ChatAction::UploadingPhoto < ChatAction
+    attribute :progress, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_action/uploading_video.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The user is uploading a video.
+  #
+  # @attr progress [Integer] Upload progress, as a percentage.
+  class ChatAction::UploadingVideo < ChatAction
+    attribute :progress, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_action/uploading_video_note.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The user is uploading a video note.
+  #
+  # @attr progress [Integer] Upload progress, as a percentage.
+  class ChatAction::UploadingVideoNote < ChatAction
+    attribute :progress, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_action/uploading_voice_note.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The user is uploading a voice note.
+  #
+  # @attr progress [Integer] Upload progress, as a percentage.
+  class ChatAction::UploadingVoiceNote < ChatAction
+    attribute :progress, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_event.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents a chat event.
+  #
+  # @attr id [Integer] Chat event identifier.
+  # @attr date [Integer] Point in time (Unix timestamp) when the event happened.
+  # @attr user_id [Integer] Identifier of the user who performed the action that triggered the event.
+  # @attr action [TD::Types::ChatEventAction] Action performed by the user.
+  class ChatEvent < Base
+    attribute :id, TD::Types::Integer
+    attribute :date, TD::Types::Integer
+    attribute :user_id, TD::Types::Integer
+    attribute :action, TD::Types::ChatEventAction
+  end
+end

data/lib/tdlib/types/chat_event_action.rb

@@ -0,0 +1,26 @@
+module TD::Types
+  # Represents a chat event.
+  class ChatEventAction < Base
+    %w[
+      message_edited
+      message_deleted
+      message_pinned
+      message_unpinned
+      member_joined
+      member_left
+      member_invited
+      member_promoted
+      member_restricted
+      title_changed
+      description_changed
+      username_changed
+      photo_changed
+      invites_toggled
+      sign_messages_toggled
+      sticker_set_changed
+      is_all_history_available_toggled
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/chat_event_action/#{type}"
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # The chat description was changed.
+  #
+  # @attr old_description [String] Previous chat description.
+  # @attr new_description [String] New chat description.
+  class ChatEventAction::DescriptionChanged < ChatEventAction
+    attribute :old_description, TD::Types::String
+    attribute :new_description, TD::Types::String
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # The anyone_can_invite setting of a supergroup chat was toggled.
+  #
+  # @attr anyone_can_invite [Boolean] New value of anyone_can_invite.
+  class ChatEventAction::InvitesToggled < ChatEventAction
+    attribute :anyone_can_invite, TD::Types::Bool
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # The is_all_history_available setting of a supergroup was toggled.
+  #
+  # @attr is_all_history_available [Boolean] New value of is_all_history_available.
+  class ChatEventAction::IsAllHistoryAvailableToggled < ChatEventAction
+    attribute :is_all_history_available, TD::Types::Bool
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # A new chat member was invited.
+  #
+  # @attr user_id [Integer] New member user identifier.
+  # @attr status [TD::Types::ChatMemberStatus] New member status.
+  class ChatEventAction::MemberInvited < ChatEventAction
+    attribute :user_id, TD::Types::Integer
+    attribute :status, TD::Types::ChatMemberStatus
+  end
+end

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

@@ -0,0 +1,5 @@
+module TD::Types
+  # A new member joined the chat.
+  class ChatEventAction::MemberJoined < ChatEventAction
+  end
+end

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

@@ -0,0 +1,5 @@
+module TD::Types
+  # A member left the chat.
+  class ChatEventAction::MemberLeft < ChatEventAction
+  end
+end

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

@@ -0,0 +1,12 @@
+module TD::Types
+  # A chat member has gained/lost administrator status, or the list of their administrator privileges has changed.
+  #
+  # @attr user_id [Integer] Chat member user identifier.
+  # @attr old_status [TD::Types::ChatMemberStatus] Previous status of the chat member.
+  # @attr new_status [TD::Types::ChatMemberStatus] New status of the chat member.
+  class ChatEventAction::MemberPromoted < ChatEventAction
+    attribute :user_id, TD::Types::Integer
+    attribute :old_status, TD::Types::ChatMemberStatus
+    attribute :new_status, TD::Types::ChatMemberStatus
+  end
+end

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

@@ -0,0 +1,12 @@
+module TD::Types
+  # A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed.
+  #
+  # @attr user_id [Integer] Chat member user identifier.
+  # @attr old_status [TD::Types::ChatMemberStatus] Previous status of the chat member.
+  # @attr new_status [TD::Types::ChatMemberStatus] New status of the chat member.
+  class ChatEventAction::MemberRestricted < ChatEventAction
+    attribute :user_id, TD::Types::Integer
+    attribute :old_status, TD::Types::ChatMemberStatus
+    attribute :new_status, TD::Types::ChatMemberStatus
+  end
+end