tdlib-schema 1.7.0.1

data/lib/tdlib/types/input_personal_document.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # A personal document to be saved to Telegram Passport.
+  #
+  # @attr files [Array<TD::Types::InputFile>] List of files containing the pages of the document.
+  # @attr translation [Array<TD::Types::InputFile>] List of files containing a certified English translation of the
+  #   document.
+  class InputPersonalDocument < Base
+    attribute :files, TD::Types::Array.of(TD::Types::InputFile)
+    attribute :translation, TD::Types::Array.of(TD::Types::InputFile)
+  end
+end

data/lib/tdlib/types/input_sticker.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes a sticker that needs to be added to a sticker set.
+  class InputSticker < Base
+    %w[
+      static
+      animated
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/input_sticker/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/input_sticker/animated.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # An animated sticker in TGS format.
+  #
+  # @attr sticker [TD::Types::InputFile] File with the animated sticker.
+  #   Only local or uploaded within a week files are supported.
+  #   See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements.
+  # @attr emojis [String] Emojis corresponding to the sticker.
+  class InputSticker::Animated < InputSticker
+    attribute :sticker, TD::Types::InputFile
+    attribute :emojis, TD::Types::String
+  end
+end

data/lib/tdlib/types/input_sticker/static.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # A static sticker in PNG format, which will be converted to WEBP server-side.
+  #
+  # @attr sticker [TD::Types::InputFile] PNG image with the sticker; must be up to 512 KB in size and fit in a 512x512
+  #   square.
+  # @attr emojis [String] Emojis corresponding to the sticker.
+  # @attr mask_position [TD::Types::MaskPosition, nil] For masks, position where the mask should be placed; may be
+  #   null.
+  class InputSticker::Static < InputSticker
+    attribute :sticker, TD::Types::InputFile
+    attribute :emojis, TD::Types::String
+    attribute :mask_position, TD::Types::MaskPosition.optional.default(nil)
+  end
+end

data/lib/tdlib/types/input_thumbnail.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # A thumbnail to be sent along with a file; must be in JPEG or WEBP format for stickers, and less than 200 KB in
+  #   size.
+  #
+  # @attr thumbnail [TD::Types::InputFile] Thumbnail file to send.
+  #   Sending thumbnails by file_id is currently not supported.
+  # @attr width [Integer] Thumbnail width, usually shouldn't exceed 320.
+  #   Use 0 if unknown.
+  # @attr height [Integer] Thumbnail height, usually shouldn't exceed 320.
+  #   Use 0 if unknown.
+  class InputThumbnail < Base
+    attribute :thumbnail, TD::Types::InputFile
+    attribute :width, TD::Types::Integer
+    attribute :height, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/invoice.rb

@@ -0,0 +1,31 @@
+module TD::Types
+  # Product invoice.
+  #
+  # @attr currency [String] ISO 4217 currency code.
+  # @attr price_parts [Array<TD::Types::LabeledPricePart>] A list of objects used to calculate the total price of the
+  #   product.
+  # @attr max_tip_amount [Integer] The maximum allowed amount of tip in the smallest units of the currency.
+  # @attr suggested_tip_amounts [Array<Integer>] Suggested amounts of tip in the smallest units of the currency.
+  # @attr is_test [Boolean] True, if the payment is a test payment.
+  # @attr need_name [Boolean] True, if the user's name is needed for payment.
+  # @attr need_phone_number [Boolean] True, if the user's phone number is needed for payment.
+  # @attr need_email_address [Boolean] True, if the user's email address is needed for payment.
+  # @attr need_shipping_address [Boolean] True, if the user's shipping address is needed for payment.
+  # @attr send_phone_number_to_provider [Boolean] True, if the user's phone number will be sent to the provider.
+  # @attr send_email_address_to_provider [Boolean] True, if the user's email address will be sent to the provider.
+  # @attr is_flexible [Boolean] True, if the total price depends on the shipping method.
+  class Invoice < Base
+    attribute :currency, TD::Types::String
+    attribute :price_parts, TD::Types::Array.of(TD::Types::LabeledPricePart)
+    attribute :max_tip_amount, TD::Types::Integer
+    attribute :suggested_tip_amounts, TD::Types::Array.of(TD::Types::Integer)
+    attribute :is_test, TD::Types::Bool
+    attribute :need_name, TD::Types::Bool
+    attribute :need_phone_number, TD::Types::Bool
+    attribute :need_email_address, TD::Types::Bool
+    attribute :need_shipping_address, TD::Types::Bool
+    attribute :send_phone_number_to_provider, TD::Types::Bool
+    attribute :send_email_address_to_provider, TD::Types::Bool
+    attribute :is_flexible, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/json_object_member.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents one member of a JSON object.
+  #
+  # @attr key [String] Member's key.
+  # @attr value [TD::Types::JsonValue] Member's value.
+  class JsonObjectMember < Base
+    attribute :key, TD::Types::String
+    attribute :value, TD::Types::JsonValue
+  end
+end

data/lib/tdlib/types/json_value.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Represents a JSON value.
+  class JsonValue < Base
+    %w[
+      null
+      boolean
+      number
+      string
+      array
+      object
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/json_value/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/json_value/array.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a JSON array.
+  #
+  # @attr values [Array<TD::Types::JsonValue>] The list of array elements.
+  class JsonValue::Array < JsonValue
+    attribute :values, TD::Types::Array.of(TD::Types::JsonValue)
+  end
+end

data/lib/tdlib/types/json_value/boolean.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a boolean JSON value.
+  #
+  # @attr value [Boolean] The value.
+  class JsonValue::Boolean < JsonValue
+    attribute :value, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/json_value/null.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # Represents a null JSON value.
+  class JsonValue::Null < JsonValue
+  end
+end

data/lib/tdlib/types/json_value/number.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a numeric JSON value.
+  #
+  # @attr value [Float] The value.
+  class JsonValue::Number < JsonValue
+    attribute :value, TD::Types::Float
+  end
+end

data/lib/tdlib/types/json_value/object.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a JSON object.
+  #
+  # @attr members [Array<TD::Types::JsonObjectMember>] The list of object members.
+  class JsonValue::Object < JsonValue
+    attribute :members, TD::Types::Array.of(TD::Types::JsonObjectMember)
+  end
+end

data/lib/tdlib/types/json_value/string.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a string JSON value.
+  #
+  # @attr value [String] The value.
+  class JsonValue::String < JsonValue
+    attribute :value, TD::Types::String
+  end
+end

data/lib/tdlib/types/keyboard_button.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a single button in a bot keyboard.
+  #
+  # @attr text [String] Text of the button.
+  # @attr type [TD::Types::KeyboardButtonType] Type of the button.
+  class KeyboardButton < Base
+    attribute :text, TD::Types::String
+    attribute :type, TD::Types::KeyboardButtonType
+  end
+end

data/lib/tdlib/types/keyboard_button_type.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Describes a keyboard button type.
+  class KeyboardButtonType < Base
+    %w[
+      text
+      request_phone_number
+      request_location
+      request_poll
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/keyboard_button_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/keyboard_button_type/request_location.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A button that sends the user's location when pressed; available only in private chats.
+  class KeyboardButtonType::RequestLocation < KeyboardButtonType
+  end
+end

data/lib/tdlib/types/keyboard_button_type/request_phone_number.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A button that sends the user's phone number when pressed; available only in private chats.
+  class KeyboardButtonType::RequestPhoneNumber < KeyboardButtonType
+  end
+end

data/lib/tdlib/types/keyboard_button_type/request_poll.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A button that allows the user to create and send a poll when pressed; available only in private chats.
+  #
+  # @attr force_regular [Boolean] If true, only regular polls must be allowed to create.
+  # @attr force_quiz [Boolean] If true, only polls in quiz mode must be allowed to create.
+  class KeyboardButtonType::RequestPoll < KeyboardButtonType
+    attribute :force_regular, TD::Types::Bool
+    attribute :force_quiz, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/keyboard_button_type/text.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A simple button, with text that should be sent when the button is pressed.
+  class KeyboardButtonType::Text < KeyboardButtonType
+  end
+end

data/lib/tdlib/types/labeled_price_part.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Portion of the price of a product (e.g., "delivery cost", "tax amount").
+  #
+  # @attr label [String] Label for this portion of the product price.
+  # @attr amount [Integer] Currency amount in the smallest units of the currency.
+  class LabeledPricePart < Base
+    attribute :label, TD::Types::String
+    attribute :amount, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/language_pack_info.rb

@@ -0,0 +1,35 @@
+module TD::Types
+  # Contains information about a language pack.
+  #
+  # @attr id [String] Unique language pack identifier.
+  # @attr base_language_pack_id [String, nil] Identifier of a base language pack; may be empty.
+  #   If a string is missed in the language pack, then it should be fetched from base language pack.
+  #   Unsupported in custom language packs.
+  # @attr name [String] Language name.
+  # @attr native_name [String] Name of the language in that language.
+  # @attr plural_code [String] A language code to be used to apply plural forms.
+  #   See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more info.
+  # @attr is_official [Boolean] True, if the language pack is official.
+  # @attr is_rtl [Boolean] True, if the language pack strings are RTL.
+  # @attr is_beta [Boolean] True, if the language pack is a beta language pack.
+  # @attr is_installed [Boolean] True, if the language pack is installed by the current user.
+  # @attr total_string_count [Integer] Total number of non-deleted strings from the language pack.
+  # @attr translated_string_count [Integer] Total number of translated strings from the language pack.
+  # @attr local_string_count [Integer] Total number of non-deleted strings from the language pack available locally.
+  # @attr translation_url [String, nil] Link to language translation interface; empty for custom local language packs.
+  class LanguagePackInfo < Base
+    attribute :id, TD::Types::String
+    attribute :base_language_pack_id, TD::Types::String.optional.default(nil)
+    attribute :name, TD::Types::String
+    attribute :native_name, TD::Types::String
+    attribute :plural_code, TD::Types::String
+    attribute :is_official, TD::Types::Bool
+    attribute :is_rtl, TD::Types::Bool
+    attribute :is_beta, TD::Types::Bool
+    attribute :is_installed, TD::Types::Bool
+    attribute :total_string_count, TD::Types::Integer
+    attribute :translated_string_count, TD::Types::Integer
+    attribute :local_string_count, TD::Types::Integer
+    attribute :translation_url, TD::Types::String.optional.default(nil)
+  end
+end

data/lib/tdlib/types/language_pack_string.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents one language pack string.
+  #
+  # @attr key [String] String key.
+  # @attr value [TD::Types::LanguagePackStringValue] String value.
+  class LanguagePackString < Base
+    attribute :key, TD::Types::String
+    attribute :value, TD::Types::LanguagePackStringValue
+  end
+end

data/lib/tdlib/types/language_pack_string_value.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents the value of a string in a language pack.
+  class LanguagePackStringValue < Base
+    %w[
+      ordinary
+      pluralized
+      deleted
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/language_pack_string_value/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/language_pack_string_value/deleted.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A deleted language pack string, the value should be taken from the built-in english language pack.
+  class LanguagePackStringValue::Deleted < LanguagePackStringValue
+  end
+end

data/lib/tdlib/types/language_pack_string_value/ordinary.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # An ordinary language pack string.
+  #
+  # @attr value [String] String value.
+  class LanguagePackStringValue::Ordinary < LanguagePackStringValue
+    attribute :value, TD::Types::String
+  end
+end

data/lib/tdlib/types/language_pack_string_value/pluralized.rb

@@ -0,0 +1,19 @@
+module TD::Types
+  # A language pack string which has different forms based on the number of some object it mentions.
+  # See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more info.
+  #
+  # @attr zero_value [String] Value for zero objects.
+  # @attr one_value [String] Value for one object.
+  # @attr two_value [String] Value for two objects.
+  # @attr few_value [String] Value for few objects.
+  # @attr many_value [String] Value for many objects.
+  # @attr other_value [String] Default value.
+  class LanguagePackStringValue::Pluralized < LanguagePackStringValue
+    attribute :zero_value, TD::Types::String
+    attribute :one_value, TD::Types::String
+    attribute :two_value, TD::Types::String
+    attribute :few_value, TD::Types::String
+    attribute :many_value, TD::Types::String
+    attribute :other_value, TD::Types::String
+  end
+end

data/lib/tdlib/types/language_pack_strings.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of language pack strings.
+  #
+  # @attr strings [Array<TD::Types::LanguagePackString>] A list of language pack strings.
+  class LanguagePackStrings < Base
+    attribute :strings, TD::Types::Array.of(TD::Types::LanguagePackString)
+  end
+end

data/lib/tdlib/types/local_file.rb

@@ -0,0 +1,28 @@
+module TD::Types
+  # Represents a local file.
+  #
+  # @attr path [String, nil] Local path to the locally available file part; may be empty.
+  # @attr can_be_downloaded [Boolean] True, if it is possible to try to download or generate the file.
+  # @attr can_be_deleted [Boolean] True, if the file can be deleted.
+  # @attr is_downloading_active [Boolean] True, if the file is currently being downloaded (or a local copy is being
+  #   generated by some other means).
+  # @attr is_downloading_completed [Boolean] True, if the local copy is fully available.
+  # @attr download_offset [Integer] Download will be started from this offset.
+  #   downloaded_prefix_size is calculated from this offset.
+  # @attr downloaded_prefix_size [Integer] If is_downloading_completed is false, then only some prefix of the file
+  #   starting from download_offset is ready to be read.
+  #   downloaded_prefix_size is the size of that prefix.
+  # @attr downloaded_size [Integer] Total downloaded file bytes.
+  #   Should be used only for calculating download progress.
+  #   The actual file size may be bigger, and some parts of it may contain garbage.
+  class LocalFile < Base
+    attribute :path, TD::Types::String.optional.default(nil)
+    attribute :can_be_downloaded, TD::Types::Bool
+    attribute :can_be_deleted, TD::Types::Bool
+    attribute :is_downloading_active, TD::Types::Bool
+    attribute :is_downloading_completed, TD::Types::Bool
+    attribute :download_offset, TD::Types::Integer
+    attribute :downloaded_prefix_size, TD::Types::Integer
+    attribute :downloaded_size, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/localization_target_info.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains information about the current localization target.
+  #
+  # @attr language_packs [Array<TD::Types::LanguagePackInfo>] List of available language packs for this application.
+  class LocalizationTargetInfo < Base
+    attribute :language_packs, TD::Types::Array.of(TD::Types::LanguagePackInfo)
+  end
+end

data/lib/tdlib/types/location.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Describes a location on planet Earth.
+  #
+  # @attr latitude [Float] Latitude of the location in degrees; as defined by the sender.
+  # @attr longitude [Float] Longitude of the location, in degrees; as defined by the sender.
+  # @attr horizontal_accuracy [Float] The estimated horizontal accuracy of the location, in meters; as defined by the
+  #   sender.
+  #   0 if unknown.
+  class Location < Base
+    attribute :latitude, TD::Types::Float
+    attribute :longitude, TD::Types::Float
+    attribute :horizontal_accuracy, TD::Types::Float
+  end
+end

data/lib/tdlib/types/log_stream.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Describes a stream to which TDLib internal log is written.
+  class LogStream < Base
+    %w[
+      default
+      file
+      empty
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/log_stream/#{type}"
+    end
+  end
+end