twitter-status-bot/.gems/gems/twitter-5.11.0/lib/twitter/rest/help.rb

57 lines
2.1 KiB
Ruby

require 'twitter/configuration'
require 'twitter/language'
require 'twitter/request'
require 'twitter/rest/utils'
module Twitter
module REST
module Help
include Twitter::REST::Utils
# Returns the current configuration used by Twitter
#
# @see https://dev.twitter.com/docs/api/1.1/get/help/configuration
# @rate_limited Yes
# @authentication Requires user context
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
# @return [Twitter::Configuration] Twitter's configuration.
def configuration(options = {})
perform_with_object(:get, '/1.1/help/configuration.json', options, Twitter::Configuration)
end
# Returns the list of languages supported by Twitter
#
# @see https://dev.twitter.com/docs/api/1.1/get/help/languages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
# @return [Array<Twitter::Language>]
def languages(options = {})
perform_with_objects(:get, '/1.1/help/languages.json', options, Twitter::Language)
end
# Returns {https://twitter.com/privacy Twitter's Privacy Policy}
#
# @see https://dev.twitter.com/docs/api/1.1/get/help/privacy
# @rate_limited Yes
# @authentication Requires user context
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
# @return [String]
def privacy(options = {})
get('/1.1/help/privacy.json', options).body[:privacy]
end
# Returns {https://twitter.com/tos Twitter's Terms of Service}
#
# @see https://dev.twitter.com/docs/api/1.1/get/help/tos
# @rate_limited Yes
# @authentication Requires user context
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
# @return [String]
def tos(options = {})
get('/1.1/help/tos.json', options).body[:tos]
end
end
end
end