tdlib-schema 1.7.0.1

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

@@ -0,0 +1,13 @@
+module TD::Types
+  # A PNG or TGV (gzipped subset of SVG with MIME type "application/x-tgwallpattern") pattern to be combined with the
+  #   background fill chosen by the user.
+  #
+  # @attr fill [TD::Types::BackgroundFill] Description of the background fill.
+  # @attr intensity [Integer] Intensity of the pattern when it is shown above the filled background; 0-100.
+  # @attr is_moving [Boolean] True, if the background needs to be slightly moved when device is tilted.
+  class BackgroundType::Pattern < BackgroundType
+    attribute :fill, TD::Types::BackgroundFill
+    attribute :intensity, TD::Types::Integer
+    attribute :is_moving, TD::Types::Bool
+  end
+end

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

@@ -0,0 +1,11 @@
+module TD::Types
+  # A wallpaper in JPEG format.
+  #
+  # @attr is_blurred [Boolean] True, if the wallpaper must be downscaled to fit in 450x450 square and then box-blurred
+  #   with radius 12.
+  # @attr is_moving [Boolean] True, if the background needs to be slightly moved when device is tilted.
+  class BackgroundType::Wallpaper < BackgroundType
+    attribute :is_blurred, TD::Types::Bool
+    attribute :is_moving, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/backgrounds.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of backgrounds.
+  #
+  # @attr backgrounds [Array<TD::Types::Background>] A list of backgrounds.
+  class Backgrounds < Base
+    attribute :backgrounds, TD::Types::Array.of(TD::Types::Background)
+  end
+end

data/lib/tdlib/types/bank_card_action_open_url.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Describes an action associated with a bank card number.
+  #
+  # @attr text [String] Action text.
+  # @attr url [String] The URL to be opened.
+  class BankCardActionOpenUrl < Base
+    attribute :text, TD::Types::String
+    attribute :url, TD::Types::String
+  end
+end

data/lib/tdlib/types/bank_card_info.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Information about a bank card.
+  #
+  # @attr title [String] Title of the bank card description.
+  # @attr actions [Array<TD::Types::BankCardActionOpenUrl>] Actions that can be done with the bank card number.
+  class BankCardInfo < Base
+    attribute :title, TD::Types::String
+    attribute :actions, TD::Types::Array.of(TD::Types::BankCardActionOpenUrl)
+  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
+    schema schema.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,16 @@
+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 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 :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,19 @@
+module TD::Types
+  # Contains full information about a basic group.
+  #
+  # @attr photo [TD::Types::ChatPhoto, nil] Chat photo; may be null.
+  # @attr description [String] Group description.
+  #   Updated only after the basic group is opened.
+  # @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 [TD::Types::ChatInviteLink, nil] Primary invite link for this group; may be null.
+  #   For chat administrators with can_invite_users right only.
+  #   Updated only after the basic group is opened.
+  class BasicGroupFullInfo < Base
+    attribute :photo, TD::Types::ChatPhoto.optional.default(nil)
+    attribute :description, TD::Types::String
+    attribute :creator_user_id, TD::Types::Integer
+    attribute :members, TD::Types::Array.of(TD::Types::ChatMember)
+    attribute :invite_link, TD::Types::ChatInviteLink.optional.default(nil)
+  end
+end

data/lib/tdlib/types/bot_command.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a command 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,16 @@
+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 is_video [Boolean] True, if the call is a video call.
+  # @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 :is_video, TD::Types::Bool
+    attribute :state, TD::Types::CallState
+  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

data/lib/tdlib/types/call_problem.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Describes the exact type of a problem with a call.
+  class CallProblem < Base
+    %w[
+      echo
+      noise
+      interruptions
+      distorted_speech
+      silent_local
+      silent_remote
+      dropped
+      distorted_video
+      pixelated_video
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/call_problem/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/call_problem/distorted_speech.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The speech was distorted.
+  class CallProblem::DistortedSpeech < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/distorted_video.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The video was distorted.
+  class CallProblem::DistortedVideo < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/dropped.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The call ended unexpectedly.
+  class CallProblem::Dropped < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/echo.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user heard their own voice.
+  class CallProblem::Echo < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/interruptions.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The other side kept disappearing.
+  class CallProblem::Interruptions < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/noise.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user heard background noise.
+  class CallProblem::Noise < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/pixelated_video.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The video was pixelated.
+  class CallProblem::PixelatedVideo < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/silent_local.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user couldn't hear the other side.
+  class CallProblem::SilentLocal < CallProblem
+  end
+end

data/lib/tdlib/types/call_problem/silent_remote.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The other side couldn't hear the user.
+  class CallProblem::SilentRemote < CallProblem
+  end
+end

data/lib/tdlib/types/call_protocol.rb

@@ -0,0 +1,16 @@
+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] The minimum supported API layer; use 65.
+  # @attr max_layer [Integer] The maximum supported API layer; use 65.
+  # @attr library_versions [Array<String>] List of supported tgcalls versions.
+  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
+    attribute :library_versions, TD::Types::Array.of(TD::Types::String)
+  end
+end

data/lib/tdlib/types/call_server.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Describes a server for relaying call data.
+  #
+  # @attr id [Integer] Server identifier.
+  # @attr ip_address [String] Server IPv4 address.
+  # @attr ipv6_address [String] Server IPv6 address.
+  # @attr port [Integer] Server port number.
+  # @attr type [TD::Types::CallServerType] Server type.
+  class CallServer < Base
+    attribute :id, TD::Types::Integer
+    attribute :ip_address, TD::Types::String
+    attribute :ipv6_address, TD::Types::String
+    attribute :port, TD::Types::Integer
+    attribute :type, TD::Types::CallServerType
+  end
+end

data/lib/tdlib/types/call_server_type.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes the type of a call server.
+  class CallServerType < Base
+    %w[
+      telegram_reflector
+      webrtc
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/call_server_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/call_server_type/telegram_reflector.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A Telegram call reflector.
+  #
+  # @attr peer_tag [String] A peer tag to be used with the reflector.
+  class CallServerType::TelegramReflector < CallServerType
+    attribute :peer_tag, TD::Types::String
+  end
+end

data/lib/tdlib/types/call_server_type/webrtc.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # A WebRTC server.
+  #
+  # @attr username [String] Username to be used for authentication.
+  # @attr password [String] Authentication password.
+  # @attr supports_turn [Boolean] True, if the server supports TURN.
+  # @attr supports_stun [Boolean] True, if the server supports STUN.
+  class CallServerType::Webrtc < CallServerType
+    attribute :username, TD::Types::String
+    attribute :password, TD::Types::String
+    attribute :supports_turn, TD::Types::Bool
+    attribute :supports_stun, TD::Types::Bool
+  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