tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/messages.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains a list of messages.
+  #
+  # @attr total_count [Integer] Approximate total count of messages found.
+  # @attr messages [Array<TD::Types::Message>, nil] List of messages; messages may be null.
+  class Messages < Base
+    attribute :total_count, TD::Types::Integer
+    attribute :messages, TD::Types::Array.of(TD::Types::Message).optional.default(nil)
+  end
+end

data/lib/tdlib/types/network_statistics.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A full list of available network statistic entries.
+  #
+  # @attr since_date [Integer] Point in time (Unix timestamp) when the app began collecting statistics.
+  # @attr entries [Array<TD::Types::NetworkStatisticsEntry>] Network statistics entries.
+  class NetworkStatistics < Base
+    attribute :since_date, TD::Types::Integer
+    attribute :entries, TD::Types::Array.of(TD::Types::NetworkStatisticsEntry)
+  end
+end

data/lib/tdlib/types/network_statistics_entry.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Contains statistics about network usage.
+  class NetworkStatisticsEntry < Base
+    %w[
+      file
+      call
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/network_statistics_entry/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/network_statistics_entry/call.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Contains information about the total amount of data that was used for calls.
+  #
+  # @attr network_type [TD::Types::NetworkType] Type of the network the data was sent through.
+  #   Call setNetworkType to maintain the actual network type.
+  # @attr sent_bytes [Integer] Total number of bytes sent.
+  # @attr received_bytes [Integer] Total number of bytes received.
+  # @attr duration [Float] Total call duration, in seconds.
+  class NetworkStatisticsEntry::Call < NetworkStatisticsEntry
+    attribute :network_type, TD::Types::NetworkType
+    attribute :sent_bytes, TD::Types::Integer
+    attribute :received_bytes, TD::Types::Integer
+    attribute :duration, TD::Types::Float
+  end
+end

data/lib/tdlib/types/network_statistics_entry/file.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Contains information about the total amount of data that was used to send and receive files.
+  #
+  # @attr file_type [TD::Types::FileType] Type of the file the data is part of.
+  # @attr network_type [TD::Types::NetworkType] Type of the network the data was sent through.
+  #   Call setNetworkType to maintain the actual network type.
+  # @attr sent_bytes [Integer] Total number of bytes sent.
+  # @attr received_bytes [Integer] Total number of bytes received.
+  class NetworkStatisticsEntry::File < NetworkStatisticsEntry
+    attribute :file_type, TD::Types::FileType
+    attribute :network_type, TD::Types::NetworkType
+    attribute :sent_bytes, TD::Types::Integer
+    attribute :received_bytes, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/network_type.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents the type of a network.
+  class NetworkType < Base
+    %w[
+      none
+      mobile
+      mobile_roaming
+      wi_fi
+      other
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/network_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/network_type/mobile.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A mobile network.
+  class NetworkType::Mobile < NetworkType
+  end
+end

data/lib/tdlib/types/network_type/mobile_roaming.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A mobile roaming network.
+  class NetworkType::MobileRoaming < NetworkType
+  end
+end

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

@@ -0,0 +1,5 @@
+module TD::Types
+  # The network is not available.
+  class NetworkType::None < NetworkType
+  end
+end

data/lib/tdlib/types/network_type/other.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A different network type (e.g., Ethernet network).
+  class NetworkType::Other < NetworkType
+  end
+end

data/lib/tdlib/types/network_type/wi_fi.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A Wi-Fi network.
+  class NetworkType::WiFi < NetworkType
+  end
+end

data/lib/tdlib/types/notification_settings_scope.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes the types of chats to which notification settings are applied.
+  class NotificationSettingsScope < Base
+    %w[
+      private_chats
+      group_chats
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/notification_settings_scope/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/notification_settings_scope/group_chats.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # Notification settings applied to all basic groups, supergroups and channels when the corresponding chat setting has
+  #   a default value.
+  class NotificationSettingsScope::GroupChats < NotificationSettingsScope
+  end
+end

data/lib/tdlib/types/notification_settings_scope/private_chats.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # Notification settings applied to all private and secret chats when the corresponding chat setting has a default
+  #   value.
+  class NotificationSettingsScope::PrivateChats < NotificationSettingsScope
+  end
+end

data/lib/tdlib/types/ok.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # An object of this type is returned on a successful function call for certain functions.
+  class Ok < Base
+  end
+end

data/lib/tdlib/types/option_value.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Represents the value of an option.
+  class OptionValue < Base
+    %w[
+      boolean
+      empty
+      integer
+      string
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/option_value/#{type}"
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # Boolean option.
+  #
+  # @attr value [Boolean] The value of the option.
+  class OptionValue::Boolean < OptionValue
+    attribute :value, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/option_value/empty.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # An unknown option or an option which has a default value.
+  class OptionValue::Empty < OptionValue
+  end
+end

data/lib/tdlib/types/option_value/integer.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # An integer option.
+  #
+  # @attr value [Integer] The value of the option.
+  class OptionValue::Integer < OptionValue
+    attribute :value, TD::Types::Integer
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # A string option.
+  #
+  # @attr value [String] The value of the option.
+  class OptionValue::String < OptionValue
+    attribute :value, TD::Types::String
+  end
+end

data/lib/tdlib/types/order_info.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Order information.
+  #
+  # @attr name [String] Name of the user.
+  # @attr phone_number [String] Phone number of the user.
+  # @attr email_address [String] Email address of the user.
+  # @attr shipping_address [TD::Types::Address, nil] Shipping address for this order; may be null.
+  class OrderInfo < Base
+    attribute :name, TD::Types::String
+    attribute :phone_number, TD::Types::String
+    attribute :email_address, TD::Types::String
+    attribute :shipping_address, TD::Types::Address.optional.default(nil)
+  end
+end

data/lib/tdlib/types/page_block.rb

@@ -0,0 +1,32 @@
+module TD::Types
+  # Describes a block of an instant view web page.
+  class PageBlock < Base
+    %w[
+      title
+      subtitle
+      author_date
+      header
+      subheader
+      paragraph
+      preformatted
+      footer
+      divider
+      anchor
+      list
+      block_quote
+      pull_quote
+      animation
+      audio
+      photo
+      video
+      cover
+      embedded
+      embedded_post
+      collage
+      slideshow
+      chat_link
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/page_block/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/page_block/anchor.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor.
+  #
+  # @attr name [String] Name of the anchor.
+  class PageBlock::Anchor < PageBlock
+    attribute :name, TD::Types::String
+  end
+end

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

@@ -0,0 +1,12 @@
+module TD::Types
+  # An animation.
+  #
+  # @attr animation [TD::Types::Animation, nil] Animation file; may be null.
+  # @attr caption [TD::Types::RichText] Animation caption.
+  # @attr need_autoplay [Boolean] True, if the animation should be played automatically.
+  class PageBlock::Animation < PageBlock
+    attribute :animation, TD::Types::Animation.optional.default(nil)
+    attribute :caption, TD::Types::RichText
+    attribute :need_autoplay, TD::Types::Bool
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # An audio file.
+  #
+  # @attr audio [TD::Types::Audio, nil] Audio file; may be null.
+  # @attr caption [TD::Types::RichText] Audio file caption.
+  class PageBlock::Audio < PageBlock
+    attribute :audio, TD::Types::Audio.optional.default(nil)
+    attribute :caption, TD::Types::RichText
+  end
+end

data/lib/tdlib/types/page_block/author_date.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # The author and publishing date of a page.
+  #
+  # @attr author [TD::Types::RichText] Author.
+  # @attr publish_date [Integer] Point in time (Unix timestamp) when the article was published; 0 if unknown.
+  class PageBlock::AuthorDate < PageBlock
+    attribute :author, TD::Types::RichText
+    attribute :publish_date, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/page_block/block_quote.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A block quote.
+  #
+  # @attr text [TD::Types::RichText] Quote text.
+  # @attr caption [TD::Types::RichText] Quote caption.
+  class PageBlock::BlockQuote < PageBlock
+    attribute :text, TD::Types::RichText
+    attribute :caption, TD::Types::RichText
+  end
+end

data/lib/tdlib/types/page_block/chat_link.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # A link to a chat.
+  #
+  # @attr title [String] Chat title.
+  # @attr photo [TD::Types::ChatPhoto, nil] Chat photo; may be null.
+  # @attr username [String] Chat username, by which all other information about the chat should be resolved.
+  class PageBlock::ChatLink < PageBlock
+    attribute :title, TD::Types::String
+    attribute :photo, TD::Types::ChatPhoto.optional.default(nil)
+    attribute :username, TD::Types::String
+  end
+end

data/lib/tdlib/types/page_block/collage.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A collage.
+  #
+  # @attr page_blocks [Array<TD::Types::PageBlock>] Collage item contents.
+  # @attr caption [TD::Types::RichText] Block caption.
+  class PageBlock::Collage < PageBlock
+    attribute :page_blocks, TD::Types::Array.of(TD::Types::PageBlock)
+    attribute :caption, TD::Types::RichText
+  end
+end

data/lib/tdlib/types/page_block/cover.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A page cover.
+  #
+  # @attr cover [TD::Types::PageBlock] Cover.
+  class PageBlock::Cover < PageBlock
+    attribute :cover, TD::Types::PageBlock
+  end
+end

data/lib/tdlib/types/page_block/divider.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # An empty block separating a page.
+  class PageBlock::Divider < PageBlock
+  end
+end

data/lib/tdlib/types/page_block/embedded.rb

@@ -0,0 +1,22 @@
+module TD::Types
+  # An embedded web page.
+  #
+  # @attr url [String, nil] Web page URL, if available.
+  # @attr html [String] HTML-markup of the embedded page.
+  # @attr poster_photo [TD::Types::Photo, nil] Poster photo, if available; may be null.
+  # @attr width [Integer] Block width.
+  # @attr height [Integer] Block height.
+  # @attr caption [TD::Types::RichText] Block caption.
+  # @attr is_full_width [Boolean] True, if the block should be full width.
+  # @attr allow_scrolling [Boolean] True, if scrolling should be allowed.
+  class PageBlock::Embedded < PageBlock
+    attribute :url, TD::Types::String.optional.default(nil)
+    attribute :html, TD::Types::String
+    attribute :poster_photo, TD::Types::Photo.optional.default(nil)
+    attribute :width, TD::Types::Integer
+    attribute :height, TD::Types::Integer
+    attribute :caption, TD::Types::RichText
+    attribute :is_full_width, TD::Types::Bool
+    attribute :allow_scrolling, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/page_block/embedded_post.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # An embedded post.
+  #
+  # @attr url [String] Web page URL.
+  # @attr author [String] Post author.
+  # @attr author_photo [TD::Types::Photo] Post author photo.
+  # @attr date [Integer] Point in time (Unix timestamp) when the post was created; 0 if unknown.
+  # @attr page_blocks [Array<TD::Types::PageBlock>] Post content.
+  # @attr caption [TD::Types::RichText] Post caption.
+  class PageBlock::EmbeddedPost < PageBlock
+    attribute :url, TD::Types::String
+    attribute :author, TD::Types::String
+    attribute :author_photo, TD::Types::Photo
+    attribute :date, TD::Types::Integer
+    attribute :page_blocks, TD::Types::Array.of(TD::Types::PageBlock)
+    attribute :caption, TD::Types::RichText
+  end
+end

data/lib/tdlib/types/page_block/footer.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # The footer of a page.
+  #
+  # @attr footer [TD::Types::RichText] Footer.
+  class PageBlock::Footer < PageBlock
+    attribute :footer, TD::Types::RichText
+  end
+end

data/lib/tdlib/types/page_block/header.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A header.
+  #
+  # @attr header [TD::Types::RichText] Header.
+  class PageBlock::Header < PageBlock
+    attribute :header, TD::Types::RichText
+  end
+end

data/lib/tdlib/types/page_block/list.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # A list of texts.
+  #
+  # @attr items [Array<TD::Types::RichText>] Texts.
+  # @attr is_ordered [Boolean] True, if the items should be marked with numbers.
+  class PageBlock::List < PageBlock
+    attribute :items, TD::Types::Array.of(TD::Types::RichText)
+    attribute :is_ordered, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/page_block/paragraph.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A text paragraph.
+  #
+  # @attr text [TD::Types::RichText] Paragraph text.
+  class PageBlock::Paragraph < PageBlock
+    attribute :text, TD::Types::RichText
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # A photo.
+  #
+  # @attr photo [TD::Types::Photo, nil] Photo file; may be null.
+  # @attr caption [TD::Types::RichText] Photo caption.
+  class PageBlock::Photo < PageBlock
+    attribute :photo, TD::Types::Photo.optional.default(nil)
+    attribute :caption, TD::Types::RichText
+  end
+end