Module: SendGrid4r::REST::EmailActivity

Includes:
Request
Included in:
API
Defined in:
lib/sendgrid4r/rest/email_activity.rb

Overview

SendGrid Web API v3 EmailActivity

Defined Under Namespace

Modules: Event Classes: Activity

Constant Summary

Constants included from Request

Request::BASE_URL

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Request

#create_args, #delete, #execute, #finish, #get, #patch, #post, #process_array_params, #process_url_params, #put

Class Method Details

.create_activities(resp) ⇒ Object 



37
38
39
40
 
# File 'lib/sendgrid4r/rest/email_activity.rb', line 37

def self.create_activities(resp)
  return resp if resp.nil?
  resp.map { |activity| EmailActivity.create_activity(activity) }
end

.create_activity(resp) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/sendgrid4r/rest/email_activity.rb', line 42

def self.create_activity(resp)
  return resp if resp.nil?
  Activity.new(
    resp['email'],
    resp['event'],
    resp['created'].nil? ? nil : Time.at(resp['created']),
    resp['category'],
    resp['smtp_id'],
    resp['asm_group_id'],
    resp['msg_id'],
    resp['ip'],
    resp['url'],
    resp['reason']
  )
end

.url ⇒ Object 



33
34
35
 
# File 'lib/sendgrid4r/rest/email_activity.rb', line 33

def self.url
  "#{BASE_URL}/email_activity"
end

Instance Method Details

#get_email_activities(email: nil, events: nil, exclude_events: nil, start_time: nil, end_time: nil, &block) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/sendgrid4r/rest/email_activity.rb', line 58

def get_email_activities(
  email: nil, events: nil, exclude_events: nil, start_time: nil,
  end_time: nil, &block
)
  params = {}
  params['email'] = email unless email.nil?
  params['events'] = events unless events.nil?
  params['exclude_events'] = exclude_events unless exclude_events.nil?
  params['start_time'] = start_time.to_i unless start_time.nil?
  params['end_time'] = end_time.to_i unless end_time.nil?
  resp = get(@auth, EmailActivity.url, params, &block)
  finish(resp, @raw_resp) { |r| EmailActivity.create_activities(r) }
end