tdlib-schema 1.7.0.1

data/lib/tdlib/types/payment_form_theme.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Theme colors for a payment form.
+  #
+  # @attr background_color [Integer] A color of the payment form background in the RGB24 format.
+  # @attr text_color [Integer] A color of text in the RGB24 format.
+  # @attr hint_color [Integer] A color of hints in the RGB24 format.
+  # @attr link_color [Integer] A color of links in the RGB24 format.
+  # @attr button_color [Integer] A color of thebuttons in the RGB24 format.
+  # @attr button_text_color [Integer] A color of text on the buttons in the RGB24 format.
+  class PaymentFormTheme < Base
+    attribute :background_color, TD::Types::Integer
+    attribute :text_color, TD::Types::Integer
+    attribute :hint_color, TD::Types::Integer
+    attribute :link_color, TD::Types::Integer
+    attribute :button_color, TD::Types::Integer
+    attribute :button_text_color, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/payment_receipt.rb

@@ -0,0 +1,28 @@
+module TD::Types
+  # Contains information about a successful payment.
+  #
+  # @attr title [String] Product title.
+  # @attr description [String] Product description.
+  # @attr photo [TD::Types::Photo, nil] Product photo; may be null.
+  # @attr date [Integer] Point in time (Unix timestamp) when the payment was made.
+  # @attr seller_bot_user_id [Integer] User identifier of the seller bot.
+  # @attr payments_provider_user_id [Integer] User identifier of the payment provider bot.
+  # @attr invoice [TD::Types::Invoice] Contains information about the invoice.
+  # @attr order_info [TD::Types::OrderInfo, nil] Order information; may be null.
+  # @attr shipping_option [TD::Types::ShippingOption, nil] Chosen shipping option; may be null.
+  # @attr credentials_title [String] Title of the saved credentials chosen by the buyer.
+  # @attr tip_amount [Integer] The amount of tip chosen by the buyer in the smallest units of the currency.
+  class PaymentReceipt < Base
+    attribute :title, TD::Types::String
+    attribute :description, TD::Types::String
+    attribute :photo, TD::Types::Photo.optional.default(nil)
+    attribute :date, TD::Types::Integer
+    attribute :seller_bot_user_id, TD::Types::Integer
+    attribute :payments_provider_user_id, TD::Types::Integer
+    attribute :invoice, TD::Types::Invoice
+    attribute :order_info, TD::Types::OrderInfo.optional.default(nil)
+    attribute :shipping_option, TD::Types::ShippingOption.optional.default(nil)
+    attribute :credentials_title, TD::Types::String
+    attribute :tip_amount, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/payment_result.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Contains the result of a payment request.
+  #
+  # @attr success [Boolean] True, if the payment request was successful; otherwise the verification_url will be not
+  #   empty.
+  # @attr verification_url [String] URL for additional payment credentials verification.
+  class PaymentResult < Base
+    attribute :success, TD::Types::Bool
+    attribute :verification_url, TD::Types::String
+  end
+end

data/lib/tdlib/types/payments_provider_stripe.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Stripe payment provider.
+  #
+  # @attr publishable_key [String] Stripe API publishable key.
+  # @attr need_country [Boolean] True, if the user country must be provided.
+  # @attr need_postal_code [Boolean] True, if the user ZIP/postal code must be provided.
+  # @attr need_cardholder_name [Boolean] True, if the cardholder name must be provided.
+  class PaymentsProviderStripe < Base
+    attribute :publishable_key, TD::Types::String
+    attribute :need_country, TD::Types::Bool
+    attribute :need_postal_code, TD::Types::Bool
+    attribute :need_cardholder_name, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/personal_details.rb

@@ -0,0 +1,26 @@
+module TD::Types
+  # Contains the user's personal details.
+  #
+  # @attr first_name [String] First name of the user written in English; 1-255 characters.
+  # @attr middle_name [String] Middle name of the user written in English; 0-255 characters.
+  # @attr last_name [String] Last name of the user written in English; 1-255 characters.
+  # @attr native_first_name [String] Native first name of the user; 1-255 characters.
+  # @attr native_middle_name [String] Native middle name of the user; 0-255 characters.
+  # @attr native_last_name [String] Native last name of the user; 1-255 characters.
+  # @attr birthdate [TD::Types::Date] Birthdate of the user.
+  # @attr gender [String] Gender of the user, "male" or "female".
+  # @attr country_code [String] A two-letter ISO 3166-1 alpha-2 country code of the user's country.
+  # @attr residence_country_code [String] A two-letter ISO 3166-1 alpha-2 country code of the user's residence country.
+  class PersonalDetails < Base
+    attribute :first_name, TD::Types::String
+    attribute :middle_name, TD::Types::String
+    attribute :last_name, TD::Types::String
+    attribute :native_first_name, TD::Types::String
+    attribute :native_middle_name, TD::Types::String
+    attribute :native_last_name, TD::Types::String
+    attribute :birthdate, TD::Types::Date
+    attribute :gender, TD::Types::String
+    attribute :country_code, TD::Types::String
+    attribute :residence_country_code, TD::Types::String
+  end
+end

data/lib/tdlib/types/personal_document.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # A personal document, containing some information about a user.
+  #
+  # @attr files [Array<TD::Types::DatedFile>] List of files containing the pages of the document.
+  # @attr translation [Array<TD::Types::DatedFile>] List of files containing a certified English translation of the
+  #   document.
+  class PersonalDocument < Base
+    attribute :files, TD::Types::Array.of(TD::Types::DatedFile)
+    attribute :translation, TD::Types::Array.of(TD::Types::DatedFile)
+  end
+end

data/lib/tdlib/types/phone_number_authentication_settings.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Contains settings for the authentication of the user's phone number.
+  #
+  # @attr allow_flash_call [Boolean] Pass true if the authentication code may be sent via flash call to the specified
+  #   phone number.
+  # @attr is_current_phone_number [Boolean] Pass true if the authenticated phone number is used on the current device.
+  # @attr allow_sms_retriever_api [Boolean] For official applications only.
+  #   True, if the application can use Android SMS Retriever API (requires Google Play Services >= 10.2) to
+  #   automatically receive the authentication code from the SMS.
+  #   See https://developers.google.com/identity/sms-retriever/ for more details.
+  class PhoneNumberAuthenticationSettings < Base
+    attribute :allow_flash_call, TD::Types::Bool
+    attribute :is_current_phone_number, TD::Types::Bool
+    attribute :allow_sms_retriever_api, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/phone_number_info.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Contains information about a phone number.
+  #
+  # @attr country [TD::Types::CountryInfo, nil] Information about the country to which the phone number belongs; may be
+  #   null.
+  # @attr country_calling_code [String] The part of the phone number denoting country calling code or its part.
+  # @attr formatted_phone_number [String] The phone number without country calling code formatted accordingly to local
+  #   rules.
+  class PhoneNumberInfo < Base
+    attribute :country, TD::Types::CountryInfo.optional.default(nil)
+    attribute :country_calling_code, TD::Types::String
+    attribute :formatted_phone_number, TD::Types::String
+  end
+end

data/lib/tdlib/types/photo.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Describes a photo.
+  #
+  # @attr has_stickers [Boolean] True, if stickers were added to the photo.
+  #   The list of corresponding sticker sets can be received using getAttachedStickerSets.
+  # @attr minithumbnail [TD::Types::Minithumbnail, nil] Photo minithumbnail; may be null.
+  # @attr sizes [Array<TD::Types::PhotoSize>] Available variants of the photo, in different sizes.
+  class Photo < Base
+    attribute :has_stickers, TD::Types::Bool
+    attribute :minithumbnail, TD::Types::Minithumbnail.optional.default(nil)
+    attribute :sizes, TD::Types::Array.of(TD::Types::PhotoSize)
+  end
+end

data/lib/tdlib/types/photo_size.rb

@@ -0,0 +1,17 @@
+module TD::Types
+  # Describes an image in JPEG format.
+  #
+  # @attr type [String] Image type (see https://core.telegram.org/constructor/photoSize).
+  # @attr photo [TD::Types::File] Information about the image file.
+  # @attr width [Integer] Image width.
+  # @attr height [Integer] Image height.
+  # @attr progressive_sizes [Array<Integer>] Sizes of progressive JPEG file prefixes, which can be used to
+  #   preliminarily show the image.
+  class PhotoSize < Base
+    attribute :type, TD::Types::String
+    attribute :photo, TD::Types::File
+    attribute :width, TD::Types::Integer
+    attribute :height, TD::Types::Integer
+    attribute :progressive_sizes, TD::Types::Array.of(TD::Types::Integer)
+  end
+end

data/lib/tdlib/types/point.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A point on a Cartesian plane.
+  #
+  # @attr x [Float] The point's first coordinate.
+  # @attr y [Float] The point's second coordinate.
+  class Point < Base
+    attribute :x, TD::Types::Float
+    attribute :y, TD::Types::Float
+  end
+end

data/lib/tdlib/types/poll.rb

@@ -0,0 +1,26 @@
+module TD::Types
+  # Describes a poll.
+  #
+  # @attr id [Integer] Unique poll identifier.
+  # @attr question [String] Poll question; 1-300 characters.
+  # @attr options [Array<TD::Types::PollOption>] List of poll answer options.
+  # @attr total_voter_count [Integer] Total number of voters, participating in the poll.
+  # @attr recent_voter_user_ids [Array<Integer>] User identifiers of recent voters, if the poll is non-anonymous.
+  # @attr is_anonymous [Boolean] True, if the poll is anonymous.
+  # @attr type [TD::Types::PollType] Type of the poll.
+  # @attr open_period [Integer] Amount of time the poll will be active after creation, in seconds.
+  # @attr close_date [Integer] Point in time (Unix timestamp) when the poll will be automatically closed.
+  # @attr is_closed [Boolean] True, if the poll is closed.
+  class Poll < Base
+    attribute :id, TD::Types::Integer
+    attribute :question, TD::Types::String
+    attribute :options, TD::Types::Array.of(TD::Types::PollOption)
+    attribute :total_voter_count, TD::Types::Integer
+    attribute :recent_voter_user_ids, TD::Types::Array.of(TD::Types::Integer)
+    attribute :is_anonymous, TD::Types::Bool
+    attribute :type, TD::Types::PollType
+    attribute :open_period, TD::Types::Integer
+    attribute :close_date, TD::Types::Integer
+    attribute :is_closed, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/poll_option.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Describes one answer option of a poll.
+  #
+  # @attr text [String] Option text; 1-100 characters.
+  # @attr voter_count [Integer] Number of voters for this option, available only for closed or voted polls.
+  # @attr vote_percentage [Integer] The percentage of votes for this option; 0-100.
+  # @attr is_chosen [Boolean] True, if the option was chosen by the user.
+  # @attr is_being_chosen [Boolean] True, if the option is being chosen by a pending setPollAnswer request.
+  class PollOption < Base
+    attribute :text, TD::Types::String
+    attribute :voter_count, TD::Types::Integer
+    attribute :vote_percentage, TD::Types::Integer
+    attribute :is_chosen, TD::Types::Bool
+    attribute :is_being_chosen, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/poll_type.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes the type of a poll.
+  class PollType < Base
+    %w[
+      regular
+      quiz
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/poll_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/poll_type/quiz.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # A poll in quiz mode, which has exactly one correct answer option and can be answered only once.
+  #
+  # @attr correct_option_id [Integer] 0-based identifier of the correct answer option; -1 for a yet unanswered poll.
+  # @attr explanation [TD::Types::FormattedText, nil] Text that is shown when the user chooses an incorrect answer or
+  #   taps on the lamp icon; 0-200 characters with at most 2 line feeds; empty for a yet unanswered poll.
+  class PollType::Quiz < PollType
+    attribute :correct_option_id, TD::Types::Integer
+    attribute :explanation, TD::Types::FormattedText.optional.default(nil)
+  end
+end

data/lib/tdlib/types/poll_type/regular.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A regular poll.
+  #
+  # @attr allow_multiple_answers [Boolean] True, if multiple answer options can be chosen simultaneously.
+  class PollType::Regular < PollType
+    attribute :allow_multiple_answers, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/profile_photo.rb

@@ -0,0 +1,19 @@
+module TD::Types
+  # Describes a user profile photo.
+  #
+  # @attr id [Integer] Photo identifier; 0 for an empty photo.
+  #   Can be used to find a photo in a list of user profile photos.
+  # @attr small [TD::Types::File] A small (160x160) user profile photo.
+  #   The file can be downloaded only before the photo is changed.
+  # @attr big [TD::Types::File] A big (640x640) user profile photo.
+  #   The file can be downloaded only before the photo is changed.
+  # @attr minithumbnail [TD::Types::Minithumbnail, nil] User profile photo minithumbnail; may be null.
+  # @attr has_animation [Boolean] True, if the photo has animated variant.
+  class ProfilePhoto < Base
+    attribute :id, TD::Types::Integer
+    attribute :small, TD::Types::File
+    attribute :big, TD::Types::File
+    attribute :minithumbnail, TD::Types::Minithumbnail.optional.default(nil)
+    attribute :has_animation, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/proxies.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a list of proxy servers.
+  #
+  # @attr proxies [Array<TD::Types::Proxy>] List of proxy servers.
+  class Proxies < Base
+    attribute :proxies, TD::Types::Array.of(TD::Types::Proxy)
+  end
+end

data/lib/tdlib/types/proxy.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Contains information about a proxy server.
+  #
+  # @attr id [Integer] Unique identifier of the proxy.
+  # @attr server [String] Proxy server IP address.
+  # @attr port [Integer] Proxy server port.
+  # @attr last_used_date [Integer] Point in time (Unix timestamp) when the proxy was last used; 0 if never.
+  # @attr is_enabled [Boolean] True, if the proxy is enabled now.
+  # @attr type [TD::Types::ProxyType] Type of the proxy.
+  class Proxy < Base
+    attribute :id, TD::Types::Integer
+    attribute :server, TD::Types::String
+    attribute :port, TD::Types::Integer
+    attribute :last_used_date, TD::Types::Integer
+    attribute :is_enabled, TD::Types::Bool
+    attribute :type, TD::Types::ProxyType
+  end
+end

data/lib/tdlib/types/proxy_type.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Describes the type of a proxy server.
+  class ProxyType < Base
+    %w[
+      socks5
+      http
+      mtproto
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/proxy_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/proxy_type/http.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # A HTTP transparent proxy server.
+  #
+  # @attr username [String, nil] Username for logging in; may be empty.
+  # @attr password [String, nil] Password for logging in; may be empty.
+  # @attr http_only [Boolean] Pass true if the proxy supports only HTTP requests and doesn't support transparent TCP
+  #   connections via HTTP CONNECT method.
+  class ProxyType::Http < ProxyType
+    attribute :username, TD::Types::String.optional.default(nil)
+    attribute :password, TD::Types::String.optional.default(nil)
+    attribute :http_only, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/proxy_type/mtproto.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # An MTProto proxy server.
+  #
+  # @attr secret [String] The proxy's secret in hexadecimal encoding.
+  class ProxyType::Mtproto < ProxyType
+    attribute :secret, TD::Types::String
+  end
+end

data/lib/tdlib/types/proxy_type/socks5.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A SOCKS5 proxy server.
+  #
+  # @attr username [String, nil] Username for logging in; may be empty.
+  # @attr password [String, nil] Password for logging in; may be empty.
+  class ProxyType::Socks5 < ProxyType
+    attribute :username, TD::Types::String.optional.default(nil)
+    attribute :password, TD::Types::String.optional.default(nil)
+  end
+end

data/lib/tdlib/types/public_chat_type.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes a type of public chats.
+  class PublicChatType < Base
+    %w[
+      has_username
+      is_location_based
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/public_chat_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/public_chat_type/has_username.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The chat is public, because it has username.
+  class PublicChatType::HasUsername < PublicChatType
+  end
+end

data/lib/tdlib/types/public_chat_type/is_location_based.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The chat is public, because it is a location-based supergroup.
+  class PublicChatType::IsLocationBased < PublicChatType
+  end
+end

data/lib/tdlib/types/push_message_content.rb

@@ -0,0 +1,35 @@
+module TD::Types
+  # Contains content of a push message notification.
+  class PushMessageContent < Base
+    %w[
+      hidden
+      animation
+      audio
+      contact
+      contact_registered
+      document
+      game
+      game_score
+      invoice
+      location
+      photo
+      poll
+      screenshot_taken
+      sticker
+      text
+      video
+      video_note
+      voice_note
+      basic_group_chat_create
+      chat_add_members
+      chat_change_photo
+      chat_change_title
+      chat_delete_member
+      chat_join_by_link
+      message_forwards
+      media_album
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/push_message_content/#{type}"
+    end
+  end
+end