tdlib-schema 1.7.0.1

data/lib/tdlib/types/device_token/simple_push.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # A token for Simple Push API for Firefox OS.
+  #
+  # @attr endpoint [String, nil] Absolute URL exposed by the push service where the application server can send push
+  #   messages; may be empty to de-register a device.
+  class DeviceToken::SimplePush < DeviceToken
+    attribute :endpoint, TD::Types::String.optional.default(nil)
+  end
+end

data/lib/tdlib/types/device_token/tizen_push.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A token for Tizen Push Service.
+  #
+  # @attr reg_id [String, nil] Push service registration identifier; may be empty to de-register a device.
+  class DeviceToken::TizenPush < DeviceToken
+    attribute :reg_id, TD::Types::String.optional.default(nil)
+  end
+end

data/lib/tdlib/types/device_token/ubuntu_push.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A token for Ubuntu Push Client service.
+  #
+  # @attr token [String, nil] Token; may be empty to de-register a device.
+  class DeviceToken::UbuntuPush < DeviceToken
+    attribute :token, TD::Types::String.optional.default(nil)
+  end
+end

data/lib/tdlib/types/device_token/web_push.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # A token for web Push API.
+  #
+  # @attr endpoint [String, nil] Absolute URL exposed by the push service where the application server can send push
+  #   messages; may be empty to de-register a device.
+  # @attr p256dh_base64url [String] Base64url-encoded P-256 elliptic curve Diffie-Hellman public key.
+  # @attr auth_base64url [String] Base64url-encoded authentication secret.
+  class DeviceToken::WebPush < DeviceToken
+    attribute :endpoint, TD::Types::String.optional.default(nil)
+    attribute :p256dh_base64url, TD::Types::String
+    attribute :auth_base64url, TD::Types::String
+  end
+end

data/lib/tdlib/types/device_token/windows_push.rb

@@ -0,0 +1,9 @@
+module TD::Types
+  # A token for Windows Push Notification Services.
+  #
+  # @attr access_token [String, nil] The access token that will be used to send notifications; may be empty to
+  #   de-register a device.
+  class DeviceToken::WindowsPush < DeviceToken
+    attribute :access_token, TD::Types::String.optional.default(nil)
+  end
+end

data/lib/tdlib/types/dice_stickers.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Contains animated stickers which should be used for dice animation rendering.
+  class DiceStickers < Base
+    %w[
+      regular
+      slot_machine
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/dice_stickers/#{type}"
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # A regular animated sticker.
+  #
+  # @attr sticker [TD::Types::Sticker] The animated sticker with the dice animation.
+  class DiceStickers::Regular < DiceStickers
+    attribute :sticker, TD::Types::Sticker
+  end
+end

data/lib/tdlib/types/dice_stickers/slot_machine.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Animated stickers to be combined into a slot machine.
+  #
+  # @attr background [TD::Types::Sticker] The animated sticker with the slot machine background.
+  #   The background animation must start playing after all reel animations finish.
+  # @attr lever [TD::Types::Sticker] The animated sticker with the lever animation.
+  #   The lever animation must play once in the initial dice state.
+  # @attr left_reel [TD::Types::Sticker] The animated sticker with the left reel.
+  # @attr center_reel [TD::Types::Sticker] The animated sticker with the center reel.
+  # @attr right_reel [TD::Types::Sticker] The animated sticker with the right reel.
+  class DiceStickers::SlotMachine < DiceStickers
+    attribute :background, TD::Types::Sticker
+    attribute :lever, TD::Types::Sticker
+    attribute :left_reel, TD::Types::Sticker
+    attribute :center_reel, TD::Types::Sticker
+    attribute :right_reel, TD::Types::Sticker
+  end
+end

data/lib/tdlib/types/document.rb

@@ -0,0 +1,17 @@
+module TD::Types
+  # Describes a document of any type.
+  #
+  # @attr file_name [String] Original name of the file; as defined by the sender.
+  # @attr mime_type [String] MIME type of the file; as defined by the sender.
+  # @attr minithumbnail [TD::Types::Minithumbnail, nil] Document minithumbnail; may be null.
+  # @attr thumbnail [TD::Types::Thumbnail, nil] Document thumbnail in JPEG or PNG format (PNG will be used only for
+  #   background patterns); as defined by the sender; may be null.
+  # @attr document [TD::Types::File] File containing the document.
+  class Document < Base
+    attribute :file_name, TD::Types::String
+    attribute :mime_type, TD::Types::String
+    attribute :minithumbnail, TD::Types::Minithumbnail.optional.default(nil)
+    attribute :thumbnail, TD::Types::Thumbnail.optional.default(nil)
+    attribute :document, TD::Types::File
+  end
+end

data/lib/tdlib/types/draft_message.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Contains information about a message draft.
+  #
+  # @attr reply_to_message_id [Integer] Identifier of the message to reply to; 0 if none.
+  # @attr date [Integer] Point in time (Unix timestamp) when the draft was created.
+  # @attr input_message_text [TD::Types::InputMessageContent] Content of the message draft; this should always be of
+  #   type inputMessageText.
+  class DraftMessage < Base
+    attribute :reply_to_message_id, TD::Types::Integer
+    attribute :date, TD::Types::Integer
+    attribute :input_message_text, TD::Types::InputMessageContent
+  end
+end

data/lib/tdlib/types/email_address_authentication_code_info.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Information about the email address authentication code that was sent.
+  #
+  # @attr email_address_pattern [String] Pattern of the email address to which an authentication code was sent.
+  # @attr length [Integer] Length of the code; 0 if unknown.
+  class EmailAddressAuthenticationCodeInfo < Base
+    attribute :email_address_pattern, TD::Types::String
+    attribute :length, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/emojis.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a list of emoji.
+  #
+  # @attr emojis [Array<String>] List of emojis.
+  class Emojis < Base
+    attribute :emojis, TD::Types::Array.of(TD::Types::String)
+  end
+end

data/lib/tdlib/types/encrypted_credentials.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains encrypted Telegram Passport data credentials.
+  #
+  # @attr data [String] The encrypted credentials.
+  # @attr hash [String] The decrypted data hash.
+  # @attr secret [String] Secret for data decryption, encrypted with the service's public key.
+  class EncryptedCredentials < Base
+    attribute :data, TD::Types::String
+    attribute :hash, TD::Types::String
+    attribute :secret, TD::Types::String
+  end
+end

data/lib/tdlib/types/encrypted_passport_element.rb

@@ -0,0 +1,25 @@
+module TD::Types
+  # Contains information about an encrypted Telegram Passport element; for bots only.
+  #
+  # @attr type [TD::Types::PassportElementType] Type of Telegram Passport element.
+  # @attr data [String] Encrypted JSON-encoded data about the user.
+  # @attr front_side [TD::Types::DatedFile] The front side of an identity document.
+  # @attr reverse_side [TD::Types::DatedFile, nil] The reverse side of an identity document; may be null.
+  # @attr selfie [TD::Types::DatedFile, nil] Selfie with the document; may be null.
+  # @attr translation [Array<TD::Types::DatedFile>] List of files containing a certified English translation of the
+  #   document.
+  # @attr files [Array<TD::Types::DatedFile>] List of attached files.
+  # @attr value [String] Unencrypted data, phone number or email address.
+  # @attr hash [String] Hash of the entire element.
+  class EncryptedPassportElement < Base
+    attribute :type, TD::Types::PassportElementType
+    attribute :data, TD::Types::String
+    attribute :front_side, TD::Types::DatedFile
+    attribute :reverse_side, TD::Types::DatedFile.optional.default(nil)
+    attribute :selfie, TD::Types::DatedFile.optional.default(nil)
+    attribute :translation, TD::Types::Array.of(TD::Types::DatedFile)
+    attribute :files, TD::Types::Array.of(TD::Types::DatedFile)
+    attribute :value, TD::Types::String
+    attribute :hash, TD::Types::String
+  end
+end

data/lib/tdlib/types/error.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # An object of this type can be returned on every function call, in case of an error.
+  #
+  # @attr code [Integer] Error code; subject to future changes.
+  #   If the error code is 406, the error message must not be processed in any way and must not be displayed to the
+  #   user.
+  # @attr message [String] Error message; subject to future changes.
+  class Error < Base
+    attribute :code, TD::Types::Integer
+    attribute :message, TD::Types::String
+  end
+end

data/lib/tdlib/types/file.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # Represents a file.
+  #
+  # @attr id [Integer] Unique file identifier.
+  # @attr size [Integer] File size; 0 if unknown.
+  # @attr expected_size [Integer] Expected file size in case the exact file size is unknown, but an approximate size is
+  #   known.
+  #   Can be used to show download/upload progress.
+  # @attr local [TD::Types::LocalFile] Information about the local copy of the file.
+  # @attr remote [TD::Types::RemoteFile] Information about the remote copy of the file.
+  class File < Base
+    attribute :id, TD::Types::Integer
+    attribute :size, TD::Types::Integer
+    attribute :expected_size, TD::Types::Integer
+    attribute :local, TD::Types::LocalFile
+    attribute :remote, TD::Types::RemoteFile
+  end
+end

data/lib/tdlib/types/file_part.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a part of a file.
+  #
+  # @attr data [String] File bytes.
+  class FilePart < Base
+    attribute :data, TD::Types::String
+  end
+end

data/lib/tdlib/types/file_type.rb

@@ -0,0 +1,25 @@
+module TD::Types
+  # Represents the type of a file.
+  class FileType < Base
+    %w[
+      none
+      animation
+      audio
+      document
+      photo
+      profile_photo
+      secret
+      secret_thumbnail
+      secure
+      sticker
+      thumbnail
+      unknown
+      video
+      video_note
+      voice_note
+      wallpaper
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/file_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/file_type/animation.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is an animation.
+  class FileType::Animation < FileType
+  end
+end

data/lib/tdlib/types/file_type/audio.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is an audio file.
+  class FileType::Audio < FileType
+  end
+end

data/lib/tdlib/types/file_type/document.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a document.
+  class FileType::Document < FileType
+  end
+end

data/lib/tdlib/types/file_type/none.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The data is not a file.
+  class FileType::None < FileType
+  end
+end

data/lib/tdlib/types/file_type/photo.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a photo.
+  class FileType::Photo < FileType
+  end
+end

data/lib/tdlib/types/file_type/profile_photo.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a profile photo.
+  class FileType::ProfilePhoto < FileType
+  end
+end

data/lib/tdlib/types/file_type/secret.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file was sent to a secret chat (the file type is not known to the server).
+  class FileType::Secret < FileType
+  end
+end

data/lib/tdlib/types/file_type/secret_thumbnail.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a thumbnail of a file from a secret chat.
+  class FileType::SecretThumbnail < FileType
+  end
+end

data/lib/tdlib/types/file_type/secure.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a file from Secure storage used for storing Telegram Passport files.
+  class FileType::Secure < FileType
+  end
+end

data/lib/tdlib/types/file_type/sticker.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a sticker.
+  class FileType::Sticker < FileType
+  end
+end

data/lib/tdlib/types/file_type/thumbnail.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a thumbnail of another file.
+  class FileType::Thumbnail < FileType
+  end
+end

data/lib/tdlib/types/file_type/unknown.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file type is not yet known.
+  class FileType::Unknown < FileType
+  end
+end

data/lib/tdlib/types/file_type/video.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a video.
+  class FileType::Video < FileType
+  end
+end

data/lib/tdlib/types/file_type/video_note.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a video note.
+  class FileType::VideoNote < FileType
+  end
+end

data/lib/tdlib/types/file_type/voice_note.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a voice note.
+  class FileType::VoiceNote < FileType
+  end
+end

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

@@ -0,0 +1,5 @@
+module TD::Types
+  # The file is a wallpaper or a background pattern.
+  class FileType::Wallpaper < FileType
+  end
+end

data/lib/tdlib/types/formatted_text.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # A text with some entities.
+  #
+  # @attr text [String] The text.
+  # @attr entities [Array<TD::Types::TextEntity>] Entities contained in the text.
+  #   Entities can be nested, but must not mutually intersect with each other.
+  #   Pre, Code and PreCode entities can't contain other entities.
+  #   Bold, Italic, Underline and Strikethrough entities can contain and to be contained in all other entities.
+  #   All other entities can't contain each other.
+  class FormattedText < Base
+    attribute :text, TD::Types::String
+    attribute :entities, TD::Types::Array.of(TD::Types::TextEntity)
+  end
+end

data/lib/tdlib/types/found_messages.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Contains a list of messages found by a search.
+  #
+  # @attr total_count [Integer] Approximate total count of messages found; -1 if unknown.
+  # @attr messages [Array<TD::Types::Message>] List of messages.
+  # @attr next_offset [String] The offset for the next request.
+  #   If empty, there are no more results.
+  class FoundMessages < Base
+    attribute :total_count, TD::Types::Integer
+    attribute :messages, TD::Types::Array.of(TD::Types::Message)
+    attribute :next_offset, TD::Types::String
+  end
+end

data/lib/tdlib/types/game.rb

@@ -0,0 +1,21 @@
+module TD::Types
+  # Describes a game.
+  #
+  # @attr id [Integer] Game ID.
+  # @attr short_name [String] Game short name.
+  #   To share a game use the URL https://t.me/{bot_username}?game={game_short_name}.
+  # @attr title [String] Game title.
+  # @attr text [TD::Types::FormattedText] Game text, usually containing scoreboards for a game.
+  # @attr description [String] Game description.
+  # @attr photo [TD::Types::Photo] Game photo.
+  # @attr animation [TD::Types::Animation, nil] Game animation; may be null.
+  class Game < Base
+    attribute :id, TD::Types::Integer
+    attribute :short_name, TD::Types::String
+    attribute :title, TD::Types::String
+    attribute :text, TD::Types::FormattedText
+    attribute :description, TD::Types::String
+    attribute :photo, TD::Types::Photo
+    attribute :animation, TD::Types::Animation.optional.default(nil)
+  end
+end

data/lib/tdlib/types/game_high_score.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Contains one row of the game high score table.
+  #
+  # @attr position [Integer] Position in the high score table.
+  # @attr user_id [Integer] User identifier.
+  # @attr score [Integer] User score.
+  class GameHighScore < Base
+    attribute :position, TD::Types::Integer
+    attribute :user_id, TD::Types::Integer
+    attribute :score, TD::Types::Integer
+  end
+end