module SendGrid4r::REST::SpamReports

SendGrid Web API v3 SpamReports

Constants

SpamReport

Public Class Methods

create_spam_report(resp) click to toggle source
# File lib/sendgrid4r/rest/spam_reports.rb, line 22
def self.create_spam_report(resp)
  return resp if resp.nil?
  created = Time.at(resp['created']) unless resp['created'].nil?
  SpamReport.new(created, resp['email'], resp['ip'])
end
create_spam_reports(resp) click to toggle source
# File lib/sendgrid4r/rest/spam_reports.rb, line 17
def self.create_spam_reports(resp)
  return resp if resp.nil?
  resp.map { |spam_report| SpamReports.create_spam_report(spam_report) }
end
url(email = nil) click to toggle source
# File lib/sendgrid4r/rest/spam_reports.rb, line 11
def self.url(email = nil)
  url = "#{BASE_URL}/suppression/spam_reports"
  url = "#{url}/#{email}" unless email.nil?
  url
end

Public Instance Methods

delete_spam_report(email:, &block) click to toggle source
# File lib/sendgrid4r/rest/spam_reports.rb, line 54
def delete_spam_report(email:, &block)
  delete(@auth, SpamReports.url(email), &block)
end
delete_spam_reports(delete_all: nil, emails: nil, &block) click to toggle source
# File lib/sendgrid4r/rest/spam_reports.rb, line 40
def delete_spam_reports(delete_all: nil, emails: nil, &block)
  if delete_all == true
    payload = { delete_all: delete_all }
  else
    payload = { emails: emails }
  end
  delete(@auth, SpamReports.url, nil, payload, &block)
end
get_spam_report(email:, &block) click to toggle source
# File lib/sendgrid4r/rest/spam_reports.rb, line 49
def get_spam_report(email:, &block)
  resp = get(@auth, SpamReports.url(email), &block)
  finish(resp, @raw_resp) { |r| SpamReports.create_spam_reports(r) }
end
get_spam_reports( start_time: nil, end_time: nil, limit: nil, offset: nil, &block ) click to toggle source
# File lib/sendgrid4r/rest/spam_reports.rb, line 28
def get_spam_reports(
  start_time: nil, end_time: nil, limit: nil, offset: nil, &block
)
  params = {}
  params[:start_time] = start_time.to_i unless start_time.nil?
  params[:end_time] = end_time.to_i unless end_time.nil?
  params[:limit] = limit.to_i unless limit.nil?
  params[:offset] = offset.to_i unless offset.nil?
  resp = get(@auth, SpamReports.url, params, &block)
  finish(resp, @raw_resp) { |r| SpamReports.create_spam_reports(r) }
end