tdlib-ruby 1.0.0 → 2.0.0

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/animation.rb

@@ -0,0 +1,21 @@
+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 thumbnail [TD::Types::PhotoSize, nil] Animation thumbnail; 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 :thumbnail, TD::Types::PhotoSize.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,22 @@
+module TD::Types
+  # Describes an audio file.
+  # Audio is usually in MP3 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_thumbnail [TD::Types::PhotoSize, nil] The thumbnail of the album cover; 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_thumbnail, TD::Types::PhotoSize.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,8 @@
+module TD::Types
+  # An authentication code is delivered via a private Telegram message, which can be viewed in another client.
+  #
+  # @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,18 @@
+module TD::Types
+  # Represents the current authorization state of the client.
+  class AuthorizationState < Base
+    %w[
+      wait_tdlib_parameters
+      wait_encryption_key
+      wait_phone_number
+      wait_code
+      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,13 @@
+module TD::Types
+  # TDLib needs the user's authentication code to finalize authorization.
+  #
+  # @attr is_registered [Boolean] True, if the user is already registered.
+  # @attr terms_of_service [TD::Types::TermsOfService, nil] Telegram terms of service, which should be accepted before
+  #   user can continue registration; may be null.
+  # @attr code_info [TD::Types::AuthenticationCodeInfo] Information about the authorization code that was sent.
+  class AuthorizationState::WaitCode < AuthorizationState
+    attribute :is_registered, TD::Types::Bool
+    attribute :terms_of_service, TD::Types::TermsOfService.optional.default(nil)
+    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_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; can 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,5 @@
+module TD::Types
+  # TDLib needs the user's phone number to authorize.
+  class AuthorizationState::WaitPhoneNumber < AuthorizationState
+  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/base.rb

@@ -0,0 +1,29 @@
+module TD::Types
+  class Base < Dry::Struct
+    # throw an error when unknown keys provided
+    input input.strict
+    
+    # convert string keys to symbols
+    transform_keys(&:to_sym)
+    
+    # resolve default types on nil
+    transform_types do |type|
+      if type.default?
+        type.constructor do |value|
+          value.nil? ? Dry::Types::Undefined : value
+        end
+      else
+        type
+      end
+    end
+    
+    def to_hash
+      { '@type' => LOOKUP_TABLE.key(self.class.name.sub('TD::Types::', '')) }.merge(super)
+    end
+    alias_method :to_h, :to_hash
+    
+    def to_json(*args)
+      to_hash.to_json(*args)
+    end
+  end
+end

data/lib/tdlib/types/basic_group.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users).
+  #
+  # @attr id [Integer] Group identifier.
+  # @attr member_count [Integer] Number of members in the group.
+  # @attr status [TD::Types::ChatMemberStatus] Status of the current user in the group.
+  # @attr everyone_is_administrator [Boolean] True, if all members have been granted administrator rights in the group.
+  # @attr is_active [Boolean] True, if the group is active.
+  # @attr upgraded_to_supergroup_id [Integer] Identifier of the supergroup to which this group was upgraded; 0 if none.
+  class BasicGroup < Base
+    attribute :id, TD::Types::Integer
+    attribute :member_count, TD::Types::Integer
+    attribute :status, TD::Types::ChatMemberStatus
+    attribute :everyone_is_administrator, TD::Types::Bool
+    attribute :is_active, TD::Types::Bool
+    attribute :upgraded_to_supergroup_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/basic_group_full_info.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Contains full information about a basic group.
+  #
+  # @attr creator_user_id [Integer] User identifier of the creator of the group; 0 if unknown.
+  # @attr members [Array<TD::Types::ChatMember>] Group members.
+  # @attr invite_link [String] Invite link for this group; available only for the group creator and only after it has
+  #   been generated at least once.
+  class BasicGroupFullInfo < Base
+    attribute :creator_user_id, TD::Types::Integer
+    attribute :members, TD::Types::Array.of(TD::Types::ChatMember)
+    attribute :invite_link, TD::Types::String
+  end
+end

data/lib/tdlib/types/bot_command.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents commands supported by a bot.
+  #
+  # @attr command [String] Text of the bot command.
+  # @attr description [String] Description of the bot command.
+  class BotCommand < Base
+    attribute :command, TD::Types::String
+    attribute :description, TD::Types::String
+  end
+end

data/lib/tdlib/types/bot_info.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Provides information about a bot and its supported commands.
+  #
+  # @attr description [String] Long description shown on the user info page.
+  # @attr commands [Array<TD::Types::BotCommand>] A list of commands supported by the bot.
+  class BotInfo < Base
+    attribute :description, TD::Types::String
+    attribute :commands, TD::Types::Array.of(TD::Types::BotCommand)
+  end
+end

data/lib/tdlib/types/call.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Describes a call.
+  #
+  # @attr id [Integer] Call identifier, not persistent.
+  # @attr user_id [Integer] Peer user identifier.
+  # @attr is_outgoing [Boolean] True, if the call is outgoing.
+  # @attr state [TD::Types::CallState] Call state.
+  class Call < Base
+    attribute :id, TD::Types::Integer
+    attribute :user_id, TD::Types::Integer
+    attribute :is_outgoing, TD::Types::Bool
+    attribute :state, TD::Types::CallState
+  end
+end

data/lib/tdlib/types/call_connection.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Describes the address of UDP reflectors.
+  #
+  # @attr id [Integer] Reflector identifier.
+  # @attr ip [String] IPv4 reflector address.
+  # @attr ipv6 [String] IPv6 reflector address.
+  # @attr port [Integer] Reflector port number.
+  # @attr peer_tag [String] Connection peer tag.
+  class CallConnection < Base
+    attribute :id, TD::Types::Integer
+    attribute :ip, TD::Types::String
+    attribute :ipv6, TD::Types::String
+    attribute :port, TD::Types::Integer
+    attribute :peer_tag, TD::Types::String
+  end
+end

data/lib/tdlib/types/call_discard_reason.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Describes the reason why a call was discarded.
+  class CallDiscardReason < Base
+    %w[
+      empty
+      missed
+      declined
+      disconnected
+      hung_up
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/call_discard_reason/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/call_discard_reason/declined.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # The call was ended before the conversation started.
+  # It was declined by the other party.
+  class CallDiscardReason::Declined < CallDiscardReason
+  end
+end

data/lib/tdlib/types/call_discard_reason/disconnected.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The call was ended during the conversation because the users were disconnected.
+  class CallDiscardReason::Disconnected < CallDiscardReason
+  end
+end

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

@@ -0,0 +1,5 @@
+module TD::Types
+  # The call wasn't discarded, or the reason is unknown.
+  class CallDiscardReason::Empty < CallDiscardReason
+  end
+end

data/lib/tdlib/types/call_discard_reason/hung_up.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The call was ended because one of the parties hung up.
+  class CallDiscardReason::HungUp < CallDiscardReason
+  end
+end

data/lib/tdlib/types/call_discard_reason/missed.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # The call was ended before the conversation started.
+  # It was cancelled by the caller or missed by the other party.
+  class CallDiscardReason::Missed < CallDiscardReason
+  end
+end

data/lib/tdlib/types/call_id.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains the call identifier.
+  #
+  # @attr id [Integer] Call identifier.
+  class CallId < Base
+    attribute :id, TD::Types::Integer
+  end
+end