tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/passport_element_type/phone_number.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A Telegram Passport element containing the user's phone number.
+  class PassportElementType::PhoneNumber < PassportElementType
+  end
+end

data/lib/tdlib/types/passport_element_type/rental_agreement.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A Telegram Passport element containing the user's rental agreement.
+  class PassportElementType::RentalAgreement < PassportElementType
+  end
+end

data/lib/tdlib/types/passport_element_type/temporary_registration.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A Telegram Passport element containing the user's temporary registration.
+  class PassportElementType::TemporaryRegistration < PassportElementType
+  end
+end

data/lib/tdlib/types/passport_element_type/utility_bill.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A Telegram Passport element containing the user's utility bill.
+  class PassportElementType::UtilityBill < PassportElementType
+  end
+end

data/lib/tdlib/types/passport_elements.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains information about saved Telegram Passport elements.
+  #
+  # @attr elements [Array<TD::Types::PassportElement>] Telegram Passport elements.
+  class PassportElements < Base
+    attribute :elements, TD::Types::Array.of(TD::Types::PassportElement)
+  end
+end

data/lib/tdlib/types/passport_required_element.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # Contains a description of the required Telegram Passport element that was requested by a service.
+  #
+  # @attr suitable_elements [Array<TD::Types::PassportSuitableElement>] List of Telegram Passport elements any of which
+  #   is enough to provide.
+  class PassportRequiredElement < Base
+    attribute :suitable_elements, TD::Types::Array.of(TD::Types::PassportSuitableElement)
+  end
+end

data/lib/tdlib/types/passport_suitable_element.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Contains information about a Telegram Passport element that was requested by a service.
+  #
+  # @attr type [TD::Types::PassportElementType] Type of the element.
+  # @attr is_selfie_required [Boolean] True, if a selfie is required with the identity document.
+  # @attr is_translation_required [Boolean] True, if a certified English translation is required with the document.
+  # @attr is_native_name_required [Boolean] True, if personal details must include the user's name in the language of
+  #   their country of residence.
+  class PassportSuitableElement < Base
+    attribute :type, TD::Types::PassportElementType
+    attribute :is_selfie_required, TD::Types::Bool
+    attribute :is_translation_required, TD::Types::Bool
+    attribute :is_native_name_required, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/password_state.rb

@@ -0,0 +1,17 @@
+module TD::Types
+  # Represents the current state of 2-step verification.
+  #
+  # @attr has_password [Boolean] True if a 2-step verification password is set.
+  # @attr password_hint [String, nil] Hint for the password; can be empty.
+  # @attr has_recovery_email_address [Boolean] True if a recovery email is set.
+  # @attr has_passport_data [Boolean] True if some Telegram Passport elements were saved.
+  # @attr unconfirmed_recovery_email_address_pattern [String] Pattern of the email address to which the confirmation
+  #   email was sent.
+  class PasswordState < Base
+    attribute :has_password, TD::Types::Bool
+    attribute :password_hint, TD::Types::String.optional.default(nil)
+    attribute :has_recovery_email_address, TD::Types::Bool
+    attribute :has_passport_data, TD::Types::Bool
+    attribute :unconfirmed_recovery_email_address_pattern, TD::Types::String
+  end
+end

data/lib/tdlib/types/payment_form.rb

@@ -0,0 +1,23 @@
+module TD::Types
+  # Contains information about an invoice payment form.
+  #
+  # @attr invoice [TD::Types::Invoice] Full information of the invoice.
+  # @attr url [String] Payment form URL.
+  # @attr payments_provider [TD::Types::PaymentsProviderStripe, nil] Contains information about the payment provider,
+  #   if available, to support it natively without the need for opening the URL; may be null.
+  # @attr saved_order_info [TD::Types::OrderInfo, nil] Saved server-side order information; may be null.
+  # @attr saved_credentials [TD::Types::SavedCredentials, nil] Contains information about saved card credentials; may
+  #   be null.
+  # @attr can_save_credentials [Boolean] True, if the user can choose to save credentials.
+  # @attr need_password [Boolean] True, if the user will be able to save credentials protected by a password they set
+  #   up.
+  class PaymentForm < Base
+    attribute :invoice, TD::Types::Invoice
+    attribute :url, TD::Types::String
+    attribute :payments_provider, TD::Types::PaymentsProviderStripe.optional.default(nil)
+    attribute :saved_order_info, TD::Types::OrderInfo.optional.default(nil)
+    attribute :saved_credentials, TD::Types::SavedCredentials.optional.default(nil)
+    attribute :can_save_credentials, TD::Types::Bool
+    attribute :need_password, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/payment_receipt.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Contains information about a successful payment.
+  #
+  # @attr date [Integer] Point in time (Unix timestamp) when the payment was made.
+  # @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] Contains 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.
+  class PaymentReceipt < Base
+    attribute :date, 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
+  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/photo.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Describes a photo.
+  #
+  # @attr id [Integer] Photo identifier; 0 for deleted photos.
+  # @attr has_stickers [Boolean] True, if stickers were added to the photo.
+  # @attr sizes [Array<TD::Types::PhotoSize>] Available variants of the photo, in different sizes.
+  class Photo < Base
+    attribute :id, TD::Types::Integer
+    attribute :has_stickers, TD::Types::Bool
+    attribute :sizes, TD::Types::Array.of(TD::Types::PhotoSize)
+  end
+end

data/lib/tdlib/types/photo_size.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Photo description.
+  #
+  # @attr type [String] Thumbnail type (see https://core.telegram.org/constructor/photoSize).
+  # @attr photo [TD::Types::File] Information about the photo file.
+  # @attr width [Integer] Photo width.
+  # @attr height [Integer] Photo height.
+  class PhotoSize < Base
+    attribute :type, TD::Types::String
+    attribute :photo, TD::Types::File
+    attribute :width, TD::Types::Integer
+    attribute :height, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/profile_photo.rb

@@ -0,0 +1,13 @@
+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 userProfilePhotos.
+  # @attr small [TD::Types::File] A small (160x160) user profile photo.
+  # @attr big [TD::Types::File] A big (640x640) user profile photo.
+  class ProfilePhoto < Base
+    attribute :id, TD::Types::Integer
+    attribute :small, TD::Types::File
+    attribute :big, TD::Types::File
+  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 the 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_message_link.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains a public HTTPS link to a message in a public supergroup or channel.
+  #
+  # @attr link [String] Message link.
+  # @attr html [String] HTML-code for embedding the message.
+  class PublicMessageLink < Base
+    attribute :link, TD::Types::String
+    attribute :html, TD::Types::String
+  end
+end

data/lib/tdlib/types/recovery_email_address.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains information about the current recovery email address.
+  #
+  # @attr recovery_email_address [String] Recovery email address.
+  class RecoveryEmailAddress < Base
+    attribute :recovery_email_address, TD::Types::String
+  end
+end

data/lib/tdlib/types/remote_file.rb

@@ -0,0 +1,22 @@
+module TD::Types
+  # Represents a remote file.
+  #
+  # @attr id [String, nil] Remote file identifier; may be empty.
+  #   Can be used across application restarts or even from other devices for the current user.
+  #   If the ID starts with "http://" or "https://", it represents the HTTP URL of the file.
+  #   TDLib is currently unable to download files if only their URL is known.
+  #   If downloadFile is called on such a file or if it is sent to a secret chat, TDLib starts a file generation
+  #   process by sending {TD::Types::Update::FileGenerationStart} to the client with the HTTP URL in the original_path and
+  #   "#url#" as the conversion string.
+  #   Clients should generate the file by downloading it to the specified location.
+  # @attr is_uploading_active [Boolean] True, if the file is currently being uploaded (or a remote copy is being
+  #   generated by some other means).
+  # @attr is_uploading_completed [Boolean] True, if a remote copy is fully available.
+  # @attr uploaded_size [Integer] Size of the remote available part of the file; 0 if unknown.
+  class RemoteFile < Base
+    attribute :id, TD::Types::String.optional.default(nil)
+    attribute :is_uploading_active, TD::Types::Bool
+    attribute :is_uploading_completed, TD::Types::Bool
+    attribute :uploaded_size, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/reply_markup.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots.
+  class ReplyMarkup < Base
+    %w[
+      remove_keyboard
+      force_reply
+      show_keyboard
+      inline_keyboard
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/reply_markup/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/reply_markup/force_reply.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Instructs clients to force a reply to this message.
+  #
+  # @attr is_personal [Boolean] True, if a forced reply must automatically be shown to the current user.
+  #   For outgoing messages, specify true to show the forced reply only for the mentioned users and for the target user
+  #   of a reply.
+  class ReplyMarkup::ForceReply < ReplyMarkup
+    attribute :is_personal, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/reply_markup/inline_keyboard.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains an inline keyboard layout.
+  #
+  # @attr rows [Array<Array<TD::Types::InlineKeyboardButton>>] A list of rows of inline keyboard buttons.
+  class ReplyMarkup::InlineKeyboard < ReplyMarkup
+    attribute :rows, TD::Types::Array.of(TD::Types::Array.of(TD::Types::InlineKeyboardButton))
+  end
+end

data/lib/tdlib/types/reply_markup/remove_keyboard.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Instructs clients to remove the keyboard once this message has been received.
+  # This kind of keyboard can't be received in an incoming message; instead, UpdateChatReplyMarkup with message_id == 0
+  #   will be sent.
+  #
+  # @attr is_personal [Boolean] True, if the keyboard is removed only for the mentioned users or the target user of a
+  #   reply.
+  class ReplyMarkup::RemoveKeyboard < ReplyMarkup
+    attribute :is_personal, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/reply_markup/show_keyboard.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Contains a custom keyboard layout to quickly reply to bots.
+  #
+  # @attr rows [Array<Array<TD::Types::KeyboardButton>>] A list of rows of bot keyboard buttons.
+  # @attr resize_keyboard [Boolean] True, if the client needs to resize the keyboard vertically.
+  # @attr one_time [Boolean] True, if the client needs to hide the keyboard after use.
+  # @attr is_personal [Boolean] True, if the keyboard must automatically be shown to the current user.
+  #   For outgoing messages, specify true to show the keyboard only for the mentioned users and for the target user of
+  #   a reply.
+  class ReplyMarkup::ShowKeyboard < ReplyMarkup
+    attribute :rows, TD::Types::Array.of(TD::Types::Array.of(TD::Types::KeyboardButton))
+    attribute :resize_keyboard, TD::Types::Bool
+    attribute :one_time, TD::Types::Bool
+    attribute :is_personal, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/rich_text.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Describes a text object inside an instant-view web page.
+  class RichText < Base
+    %w[
+      plain
+      bold
+      italic
+      underline
+      strikethrough
+      fixed
+      url
+      email_address
+      s
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/rich_text/#{type}"
+    end
+  end
+end