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

28 lines
1.1 KiB
Ruby

require 'twitter/request'
require 'twitter/rest/utils'
require 'twitter/user'
module Twitter
module REST
module SpamReporting
include Twitter::REST::Utils
# The users specified are blocked by the authenticated user and reported as spammers
#
# @see https://dev.twitter.com/docs/api/1.1/post/users/report_spam
# @rate_limited Yes
# @authentication Requires user context
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
# @return [Array<Twitter::User>] The reported users.
# @overload report_spam(*users)
# @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
# @overload report_spam(*users, options)
# @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
# @param options [Hash] A customizable set of options.
def report_spam(*args)
parallel_users_from_response(:post, '/1.1/users/report_spam.json', args)
end
end
end
end