tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/chat_report_spam_state.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains information about the availability of the "Report spam" action for a chat.
+  #
+  # @attr can_report_spam [Boolean] True, if a prompt with the "Report spam" action should be shown to the user.
+  class ChatReportSpamState < Base
+    attribute :can_report_spam, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/chat_type.rb

@@ -0,0 +1,13 @@
+module TD::Types
+  # Describes the type of a chat.
+  class ChatType < Base
+    %w[
+      private
+      basic_group
+      supergroup
+      secret
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/chat_type/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/chat_type/basic_group.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # A basic group (i.e., a chat with 0-200 other users).
+  #
+  # @attr basic_group_id [Integer] Basic group identifier.
+  class ChatType::BasicGroup < ChatType
+    attribute :basic_group_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_type/private.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # An ordinary chat with a user.
+  #
+  # @attr user_id [Integer] User identifier.
+  class ChatType::Private < ChatType
+    attribute :user_id, TD::Types::Integer
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # A secret chat with a user.
+  #
+  # @attr secret_chat_id [Integer] Secret chat identifier.
+  # @attr user_id [Integer] User identifier of the secret chat peer.
+  class ChatType::Secret < ChatType
+    attribute :secret_chat_id, TD::Types::Integer
+    attribute :user_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/chat_type/supergroup.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # A supergroup (i.e.
+  # a chat with up to GetOption("supergroup_max_size") other users), or channel (with unlimited members).
+  #
+  # @attr supergroup_id [Integer] Supergroup or channel identifier.
+  # @attr is_channel [Boolean] True, if the supergroup is a channel.
+  class ChatType::Supergroup < ChatType
+    attribute :supergroup_id, TD::Types::Integer
+    attribute :is_channel, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/chats.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Represents a list of chats.
+  #
+  # @attr chat_ids [Array<Integer>] List of chat identifiers.
+  class Chats < Base
+    attribute :chat_ids, TD::Types::Array.of(TD::Types::Integer)
+  end
+end

data/lib/tdlib/types/check_chat_username_result.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Represents result of checking whether a username can be set for a chat.
+  class CheckChatUsernameResult < Base
+    %w[
+      ok
+      username_invalid
+      username_occupied
+      public_chats_too_much
+      public_groups_unavailable
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/check_chat_username_result/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/check_chat_username_result/ok.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The username can be set.
+  class CheckChatUsernameResult::Ok < CheckChatUsernameResult
+  end
+end

data/lib/tdlib/types/check_chat_username_result/public_chats_too_much.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user has too much public chats, one of them should be made private first.
+  class CheckChatUsernameResult::PublicChatsTooMuch < CheckChatUsernameResult
+  end
+end

data/lib/tdlib/types/check_chat_username_result/public_groups_unavailable.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The user can't be a member of a public supergroup.
+  class CheckChatUsernameResult::PublicGroupsUnavailable < CheckChatUsernameResult
+  end
+end

data/lib/tdlib/types/check_chat_username_result/username_invalid.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The username is invalid.
+  class CheckChatUsernameResult::UsernameInvalid < CheckChatUsernameResult
+  end
+end

data/lib/tdlib/types/check_chat_username_result/username_occupied.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # The username is occupied.
+  class CheckChatUsernameResult::UsernameOccupied < CheckChatUsernameResult
+  end
+end

data/lib/tdlib/types/connected_website.rb

@@ -0,0 +1,25 @@
+module TD::Types
+  # Contains information about one website the current user is logged in with Telegram.
+  #
+  # @attr id [Integer] Website identifier.
+  # @attr domain_name [String] The domain name of the website.
+  # @attr bot_user_id [Integer] User identifier of a bot linked with the website.
+  # @attr browser [String] The version of a browser used to log in.
+  # @attr platform [String] Operating system the browser is running on.
+  # @attr log_in_date [Integer] Point in time (Unix timestamp) when the user was logged in.
+  # @attr last_active_date [Integer] Point in time (Unix timestamp) when obtained authorization was last used.
+  # @attr ip [String] IP address from which the user was logged in, in human-readable format.
+  # @attr location [String] Human-readable description of a country and a region, from which the user was logged in,
+  #   based on the IP address.
+  class ConnectedWebsite < Base
+    attribute :id, TD::Types::Integer
+    attribute :domain_name, TD::Types::String
+    attribute :bot_user_id, TD::Types::Integer
+    attribute :browser, TD::Types::String
+    attribute :platform, TD::Types::String
+    attribute :log_in_date, TD::Types::Integer
+    attribute :last_active_date, TD::Types::Integer
+    attribute :ip, TD::Types::String
+    attribute :location, TD::Types::String
+  end
+end

data/lib/tdlib/types/connected_websites.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of websites the current user is logged in with Telegram.
+  #
+  # @attr websites [Array<TD::Types::ConnectedWebsite>] List of connected websites.
+  class ConnectedWebsites < Base
+    attribute :websites, TD::Types::Array.of(TD::Types::ConnectedWebsite)
+  end
+end

data/lib/tdlib/types/connection_state.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Describes the current state of the connection to Telegram servers.
+  class ConnectionState < Base
+    %w[
+      waiting_for_network
+      connecting_to_proxy
+      connecting
+      updating
+      ready
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/connection_state/#{type}"
+    end
+  end
+end

data/lib/tdlib/types/connection_state/connecting.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # Currently establishing a connection to the Telegram servers.
+  class ConnectionState::Connecting < ConnectionState
+  end
+end

data/lib/tdlib/types/connection_state/connecting_to_proxy.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # Currently establishing a connection with a proxy server.
+  class ConnectionState::ConnectingToProxy < ConnectionState
+  end
+end

data/lib/tdlib/types/connection_state/ready.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # There is a working connection to the Telegram servers.
+  class ConnectionState::Ready < ConnectionState
+  end
+end

data/lib/tdlib/types/connection_state/updating.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # Downloading data received while the client was offline.
+  class ConnectionState::Updating < ConnectionState
+  end
+end

data/lib/tdlib/types/connection_state/waiting_for_network.rb

@@ -0,0 +1,6 @@
+module TD::Types
+  # Currently waiting for the network to become available.
+  # Use SetNetworkType to change the available network type.
+  class ConnectionState::WaitingForNetwork < ConnectionState
+  end
+end

data/lib/tdlib/types/contact.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Describes a user contact.
+  #
+  # @attr phone_number [String] Phone number of the user.
+  # @attr first_name [String] First name of the user; 1-255 characters in length.
+  # @attr last_name [String] Last name of the user.
+  # @attr vcard [String] Additional data about the user in a form of vCard; 0-2048 bytes in length.
+  # @attr user_id [Integer] Identifier of the user, if known; otherwise 0.
+  class Contact < Base
+    attribute :phone_number, TD::Types::String
+    attribute :first_name, TD::Types::String
+    attribute :last_name, TD::Types::String
+    attribute :vcard, TD::Types::String
+    attribute :user_id, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/count.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a counter.
+  #
+  # @attr count [Integer] Count.
+  class Count < Base
+    attribute :count, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/custom_request_result.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains the result of a custom request.
+  #
+  # @attr result [String] A JSON-serialized result.
+  class CustomRequestResult < Base
+    attribute :result, TD::Types::String
+  end
+end

data/lib/tdlib/types/date.rb

@@ -0,0 +1,12 @@
+module TD::Types
+  # Represents a date according to the Gregorian calendar.
+  #
+  # @attr day [Integer] Day of the month, 1-31.
+  # @attr month [Integer] Month, 1-12.
+  # @attr year [Integer] Year, 1-9999.
+  class Date < Base
+    attribute :day, TD::Types::Integer
+    attribute :month, TD::Types::Integer
+    attribute :year, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/dated_file.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # File with the date it was uploaded.
+  #
+  # @attr file [TD::Types::File] The file.
+  # @attr date [Integer] Point in time (Unix timestamp) when the file was uploaded.
+  class DatedFile < Base
+    attribute :file, TD::Types::File
+    attribute :date, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/deep_link_info.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Contains information about a tg:// deep link.
+  #
+  # @attr text [TD::Types::FormattedText] Text to be shown to the user.
+  # @attr need_update_application [Boolean] True, if user should be asked to update the application.
+  class DeepLinkInfo < Base
+    attribute :text, TD::Types::FormattedText
+    attribute :need_update_application, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/device_token.rb

@@ -0,0 +1,22 @@
+module TD::Types
+  # Represents a data needed to subscribe for push notifications.
+  # To use specific push notification service, you must specify the correct application platform and upload valid
+  #   server authentication data at https://my.telegram.org.
+  class DeviceToken < Base
+    %w[
+      google_cloud_messaging
+      apple_push
+      apple_push_vo_ip
+      windows_push
+      microsoft_push
+      microsoft_push_vo_ip
+      web_push
+      simple_push
+      ubuntu_push
+      black_berry_push
+      tizen_push
+    ].each do |type|
+      autoload TD::Types.camelize(type), "tdlib/types/device_token/#{type}"
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # A token for Apple Push Notification service.
+  #
+  # @attr device_token [String, nil] Device token; may be empty to de-register a device.
+  # @attr is_app_sandbox [Boolean] True, if App Sandbox is enabled.
+  class DeviceToken::ApplePush < DeviceToken
+    attribute :device_token, TD::Types::String.optional.default(nil)
+    attribute :is_app_sandbox, TD::Types::Bool
+  end
+end

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

@@ -0,0 +1,10 @@
+module TD::Types
+  # A token for Apple Push Notification service VoIP notifications.
+  #
+  # @attr device_token [String, nil] Device token; may be empty to de-register a device.
+  # @attr is_app_sandbox [Boolean] True, if App Sandbox is enabled.
+  class DeviceToken::ApplePushVoIP < DeviceToken
+    attribute :device_token, TD::Types::String.optional.default(nil)
+    attribute :is_app_sandbox, TD::Types::Bool
+  end
+end

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

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

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # A token for Google Cloud Messaging.
+  #
+  # @attr token [String, nil] Device registration token; may be empty to de-register a device.
+  class DeviceToken::GoogleCloudMessaging < DeviceToken
+    attribute :token, TD::Types::String.optional.default(nil)
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # A token for Microsoft Push Notification Service.
+  #
+  # @attr channel_uri [String, nil] Push notification channel URI; may be empty to de-register a device.
+  class DeviceToken::MicrosoftPush < DeviceToken
+    attribute :channel_uri, TD::Types::String.optional.default(nil)
+  end
+end

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

@@ -0,0 +1,8 @@
+module TD::Types
+  # A token for Microsoft Push Notification Service VoIP channel.
+  #
+  # @attr channel_uri [String, nil] Push notification channel URI; may be empty to de-register a device.
+  class DeviceToken::MicrosoftPushVoIP < DeviceToken
+    attribute :channel_uri, TD::Types::String.optional.default(nil)
+  end
+end

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/document.rb

@@ -0,0 +1,14 @@
+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 thumbnail [TD::Types::PhotoSize, nil] Document thumbnail; 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 :thumbnail, TD::Types::PhotoSize.optional.default(nil)
+    attribute :document, TD::Types::File
+  end
+end