tdlib-schema 1.7.0.1

data/lib/tdlib/types/account_ttl.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains information about the period of inactivity after which the current user's account will automatically be
+  #   deleted.
+  #
+  # @attr days [Integer] Number of days of inactivity before the account will be flagged for deletion; should range
+  #   from 30-366 days.
+  class AccountTtl < Base
+    attribute :days, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/address.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Describes an address.
+  #
+  # @attr country_code [String] A two-letter ISO 3166-1 alpha-2 country code.
+  # @attr state [String] State, if applicable.
+  # @attr city [String] City.
+  # @attr street_line1 [String] First line of the address.
+  # @attr street_line2 [String] Second line of the address.
+  # @attr postal_code [String] Address postal code.
+  class Address < Base
+    attribute :country_code, TD::Types::String
+    attribute :state, TD::Types::String
+    attribute :city, TD::Types::String
+    attribute :street_line1, TD::Types::String
+    attribute :street_line2, TD::Types::String
+    attribute :postal_code, TD::Types::String
+  end
+end

data/lib/tdlib/types/animated_chat_photo.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Animated variant of a chat photo in MPEG4 format.
+  #
+  # @attr length [Integer] Animation width and height.
+  # @attr file [TD::Types::File] Information about the animation file.
+  # @attr main_frame_timestamp [Float] Timestamp of the frame, used as a static chat photo.
+  class AnimatedChatPhoto < Base
+    attribute :length, TD::Types::Integer
+    attribute :file, TD::Types::File
+    attribute :main_frame_timestamp, TD::Types::Float
+  end
+end

data/lib/tdlib/types/animation.rb

@@ -0,0 +1,26 @@
+module TD::Types
+  # Describes an animation file.
+  # The animation must be encoded in GIF or MPEG4 format.
+  #
+  # @attr duration [Integer] Duration of the animation, in seconds; as defined by the sender.
+  # @attr width [Integer] Width of the animation.
+  # @attr height [Integer] Height of the animation.
+  # @attr file_name [String] Original name of the file; as defined by the sender.
+  # @attr mime_type [String] MIME type of the file, usually "image/gif" or "video/mp4".
+  # @attr has_stickers [Boolean] True, if stickers were added to the animation.
+  #   The list of corresponding sticker set can be received using getAttachedStickerSets.
+  # @attr minithumbnail [TD::Types::Minithumbnail, nil] Animation minithumbnail; may be null.
+  # @attr thumbnail [TD::Types::Thumbnail, nil] Animation thumbnail in JPEG or MPEG4 format; may be null.
+  # @attr animation [TD::Types::File] File containing the animation.
+  class Animation < Base
+    attribute :duration, TD::Types::Integer
+    attribute :width, TD::Types::Integer
+    attribute :height, TD::Types::Integer
+    attribute :file_name, TD::Types::String
+    attribute :mime_type, TD::Types::String
+    attribute :has_stickers, TD::Types::Bool
+    attribute :minithumbnail, TD::Types::Minithumbnail.optional.default(nil)
+    attribute :thumbnail, TD::Types::Thumbnail.optional.default(nil)
+    attribute :animation, TD::Types::File
+  end
+end

data/lib/tdlib/types/animations.rb

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

data/lib/tdlib/types/audio.rb

@@ -0,0 +1,25 @@
+module TD::Types
+  # Describes an audio file.
+  # Audio is usually in MP3 or M4A format.
+  #
+  # @attr duration [Integer] Duration of the audio, in seconds; as defined by the sender.
+  # @attr title [String] Title of the audio; as defined by the sender.
+  # @attr performer [String] Performer of the audio; as defined by the sender.
+  # @attr file_name [String] Original name of the file; as defined by the sender.
+  # @attr mime_type [String] The MIME type of the file; as defined by the sender.
+  # @attr album_cover_minithumbnail [TD::Types::Minithumbnail, nil] The minithumbnail of the album cover; may be null.
+  # @attr album_cover_thumbnail [TD::Types::Thumbnail, nil] The thumbnail of the album cover in JPEG format; as defined
+  #   by the sender.
+  #   The full size thumbnail should be extracted from the downloaded file; may be null.
+  # @attr audio [TD::Types::File] File containing the audio.
+  class Audio < Base
+    attribute :duration, TD::Types::Integer
+    attribute :title, TD::Types::String
+    attribute :performer, TD::Types::String
+    attribute :file_name, TD::Types::String
+    attribute :mime_type, TD::Types::String
+    attribute :album_cover_minithumbnail, TD::Types::Minithumbnail.optional.default(nil)
+    attribute :album_cover_thumbnail, TD::Types::Thumbnail.optional.default(nil)
+    attribute :audio, TD::Types::File
+  end
+end

data/lib/tdlib/types/authentication_code_info.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Information about the authentication code that was sent.
+  #
+  # @attr phone_number [String] A phone number that is being authenticated.
+  # @attr type [TD::Types::AuthenticationCodeType] Describes the way the code was sent to the user.
+  # @attr next_type [TD::Types::AuthenticationCodeType, nil] Describes the way the next code will be sent to the user;
+  #   may be null.
+  # @attr timeout [Integer] Timeout before the code should be re-sent, in seconds.
+  class AuthenticationCodeInfo < Base
+    attribute :phone_number, TD::Types::String
+    attribute :type, TD::Types::AuthenticationCodeType
+    attribute :next_type, TD::Types::AuthenticationCodeType.optional.default(nil)
+    attribute :timeout, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/authentication_code_type.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Provides information about the method by which an authentication code is delivered to the user.
+  class AuthenticationCodeType < Base
+    %w[
+      telegram_message
+      sms
+      call
+      flash_call
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/authentication_code_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/authentication_code_type/call.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # An authentication code is delivered via a phone call to the specified phone number.
+  #
+  # @attr length [Integer] Length of the code.
+  class AuthenticationCodeType::Call < AuthenticationCodeType
+    attribute :length, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/authentication_code_type/flash_call.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # An authentication code is delivered by an immediately cancelled call to the specified phone number.
+  # The number from which the call was made is the code.
+  #
+  # @attr pattern [String] Pattern of the phone number from which the call will be made.
+  class AuthenticationCodeType::FlashCall < AuthenticationCodeType
+    attribute :pattern, TD::Types::String
+  end
+end

data/lib/tdlib/types/authentication_code_type/sms.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # An authentication code is delivered via an SMS message to the specified phone number.
+  #
+  # @attr length [Integer] Length of the code.
+  class AuthenticationCodeType::Sms < AuthenticationCodeType
+    attribute :length, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/authentication_code_type/telegram_message.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # An authentication code is delivered via a private Telegram message, which can be viewed from another active
+  #   session.
+  #
+  # @attr length [Integer] Length of the code.
+  class AuthenticationCodeType::TelegramMessage < AuthenticationCodeType
+    attribute :length, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/authorization_state.rb

@@ -0,0 +1,20 @@
+module TD::Types
+  # Represents the current authorization state of the TDLib client.
+  class AuthorizationState < Base
+    %w[
+      wait_tdlib_parameters
+      wait_encryption_key
+      wait_phone_number
+      wait_code
+      wait_other_device_confirmation
+      wait_registration
+      wait_password
+      ready
+      logging_out
+      closing
+      closed
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/authorization_state/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/authorization_state/closed.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # TDLib client is in its final state.
+  # All databases are closed and all resources are released.
+  # No other updates will be received after this.
+  # All queries will be responded to with error code 500.
+  # To continue working, one should create a new instance of the TDLib client.
+  class AuthorizationState::Closed < AuthorizationState
+  end
+end

data/lib/tdlib/types/authorization_state/closing.rb

@@ -0,0 +1,7 @@
+module TD::Types
+  # TDLib is closing, all subsequent queries will be answered with the error 500.
+  # Note that closing TDLib can take a while.
+  # All resources will be freed only after authorizationStateClosed has been received.
+  class AuthorizationState::Closing < AuthorizationState
+  end
+end

data/lib/tdlib/types/authorization_state/logging_out.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user is currently logging out.
+  class AuthorizationState::LoggingOut < AuthorizationState
+  end
+end

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

@@ -0,0 +1,6 @@
+module TD::Types
+  # The user has been successfully authorized.
+  # TDLib is now ready to answer queries.
+  class AuthorizationState::Ready < AuthorizationState
+  end
+end

data/lib/tdlib/types/authorization_state/wait_code.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # TDLib needs the user's authentication code to authorize.
+  #
+  # @attr code_info [TD::Types::AuthenticationCodeInfo] Information about the authorization code that was sent.
+  class AuthorizationState::WaitCode < AuthorizationState
+    attribute :code_info, TD::Types::AuthenticationCodeInfo
+  end
+end

data/lib/tdlib/types/authorization_state/wait_encryption_key.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # TDLib needs an encryption key to decrypt the local database.
+  #
+  # @attr is_encrypted [Boolean] True, if the database is currently encrypted.
+  class AuthorizationState::WaitEncryptionKey < AuthorizationState
+    attribute :is_encrypted, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/authorization_state/wait_other_device_confirmation.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link.
+  #
+  # @attr link [String] A tg:// URL for the QR code.
+  #   The link will be updated frequently.
+  class AuthorizationState::WaitOtherDeviceConfirmation < AuthorizationState
+    attribute :link, TD::Types::String
+  end
+end

data/lib/tdlib/types/authorization_state/wait_password.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # The user has been authorized, but needs to enter a password to start using the application.
+  #
+  # @attr password_hint [String, nil] Hint for the password; may be empty.
+  # @attr has_recovery_email_address [Boolean] True, if a recovery email address has been set up.
+  # @attr recovery_email_address_pattern [String, nil] Pattern of the email address to which the recovery email was
+  #   sent; empty until a recovery email has been sent.
+  class AuthorizationState::WaitPassword < AuthorizationState
+    attribute :password_hint, TD::Types::String.optional.default(nil)
+    attribute :has_recovery_email_address, TD::Types::Bool
+    attribute :recovery_email_address_pattern, TD::Types::String.optional.default(nil)
+  end
+end

data/lib/tdlib/types/authorization_state/wait_phone_number.rb

@@ -0,0 +1,7 @@
+module TD::Types
+  # TDLib needs the user's phone number to authorize.
+  # Call `setAuthenticationPhoneNumber` to provide the phone number, or use `requestQrCodeAuthentication`, or
+  #   `checkAuthenticationBotToken` for other authentication options.
+  class AuthorizationState::WaitPhoneNumber < AuthorizationState
+  end
+end

data/lib/tdlib/types/authorization_state/wait_registration.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # The user is unregistered and need to accept terms of service and enter their first name and last name to finish
+  #   registration.
+  #
+  # @attr terms_of_service [TD::Types::TermsOfService] Telegram terms of service.
+  class AuthorizationState::WaitRegistration < AuthorizationState
+    attribute :terms_of_service, TD::Types::TermsOfService
+  end
+end

data/lib/tdlib/types/authorization_state/wait_tdlib_parameters.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # TDLib needs TdlibParameters for initialization.
+  class AuthorizationState::WaitTdlibParameters < AuthorizationState
+  end
+end

data/lib/tdlib/types/auto_download_settings.rb

@@ -0,0 +1,24 @@
+module TD::Types
+  # Contains auto-download settings.
+  #
+  # @attr is_auto_download_enabled [Boolean] True, if the auto-download is enabled.
+  # @attr max_photo_file_size [Integer] The maximum size of a photo file to be auto-downloaded.
+  # @attr max_video_file_size [Integer] The maximum size of a video file to be auto-downloaded.
+  # @attr max_other_file_size [Integer] The maximum size of other file types to be auto-downloaded.
+  # @attr video_upload_bitrate [Integer] The maximum suggested bitrate for uploaded videos.
+  # @attr preload_large_videos [Boolean] True, if the beginning of video files needs to be preloaded for instant
+  #   playback.
+  # @attr preload_next_audio [Boolean] True, if the next audio track needs to be preloaded while the user is listening
+  #   to an audio file.
+  # @attr use_less_data_for_calls [Boolean] True, if "use less data for calls" option needs to be enabled.
+  class AutoDownloadSettings < Base
+    attribute :is_auto_download_enabled, TD::Types::Bool
+    attribute :max_photo_file_size, TD::Types::Integer
+    attribute :max_video_file_size, TD::Types::Integer
+    attribute :max_other_file_size, TD::Types::Integer
+    attribute :video_upload_bitrate, TD::Types::Integer
+    attribute :preload_large_videos, TD::Types::Bool
+    attribute :preload_next_audio, TD::Types::Bool
+    attribute :use_less_data_for_calls, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/auto_download_settings_presets.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Contains auto-download settings presets for the user.
+  #
+  # @attr low [TD::Types::AutoDownloadSettings] Preset with lowest settings; supposed to be used by default when
+  #   roaming.
+  # @attr medium [TD::Types::AutoDownloadSettings] Preset with medium settings; supposed to be used by default when
+  #   using mobile data.
+  # @attr high [TD::Types::AutoDownloadSettings] Preset with highest settings; supposed to be used by default when
+  #   connected on Wi-Fi.
+  class AutoDownloadSettingsPresets < Base
+    attribute :low, TD::Types::AutoDownloadSettings
+    attribute :medium, TD::Types::AutoDownloadSettings
+    attribute :high, TD::Types::AutoDownloadSettings
+  end
+end

data/lib/tdlib/types/background.rb

@@ -0,0 +1,19 @@
+module TD::Types
+  # Describes a chat background.
+  #
+  # @attr id [Integer] Unique background identifier.
+  # @attr is_default [Boolean] True, if this is one of default backgrounds.
+  # @attr is_dark [Boolean] True, if the background is dark and is recommended to be used with dark theme.
+  # @attr name [String] Unique background name.
+  # @attr document [TD::Types::Document, nil] Document with the background; may be null.
+  #   Null only for filled backgrounds.
+  # @attr type [TD::Types::BackgroundType] Type of the background.
+  class Background < Base
+    attribute :id, TD::Types::Integer
+    attribute :is_default, TD::Types::Bool
+    attribute :is_dark, TD::Types::Bool
+    attribute :name, TD::Types::String
+    attribute :document, TD::Types::Document.optional.default(nil)
+    attribute :type, TD::Types::BackgroundType
+  end
+end

data/lib/tdlib/types/background_fill.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes a fill of a background.
+  class BackgroundFill < Base
+    %w[
+      solid
+      gradient
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/background_fill/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/background_fill/gradient.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Describes a gradient fill of a background.
+  #
+  # @attr top_color [Integer] A top color of the background in the RGB24 format.
+  # @attr bottom_color [Integer] A bottom color of the background in the RGB24 format.
+  # @attr rotation_angle [Integer] Clockwise rotation angle of the gradient, in degrees; 0-359.
+  #   Should be always divisible by 45.
+  class BackgroundFill::Gradient < BackgroundFill
+    attribute :top_color, TD::Types::Integer
+    attribute :bottom_color, TD::Types::Integer
+    attribute :rotation_angle, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/background_fill/solid.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Describes a solid fill of a background.
+  #
+  # @attr color [Integer] A color of the background in the RGB24 format.
+  class BackgroundFill::Solid < BackgroundFill
+    attribute :color, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/background_type.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Describes the type of a background.
+  class BackgroundType < Base
+    %w[
+      wallpaper
+      pattern
+      fill
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/background_type/#{type}"
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # A filled background.
+  #
+  # @attr fill [TD::Types::BackgroundFill] Description of the background fill.
+  class BackgroundType::Fill < BackgroundType
+    attribute :fill, TD::Types::BackgroundFill
+  end
+end