class CreateSend::Journey
Represents a journey and provides associated functionality
Attributes
journey_id[R]
Public Class Methods
new(auth, journey_id)
click to toggle source
Calls superclass method
# File lib/createsend/journey.rb, line 6 def initialize(auth, journey_id) @journey_id = journey_id super end
Public Instance Methods
email_bounces(email_id="", date="", page=1, page_size=1000, order_direction='asc')
click to toggle source
Gets a paged result of all bounces for a journey email
# File lib/createsend/journey.rb, line 38 def email_bounces(email_id="", date="", page=1, page_size=1000, order_direction='asc') paged_result_by_date("bounces", email_id, date, page, page_size, order_direction) end
email_clicks(email_id="", date="", page=1, page_size=1000, order_direction='asc')
click to toggle source
Gets a paged list of subscribers who clicked a given journey email
# File lib/createsend/journey.rb, line 28 def email_clicks(email_id="", date="", page=1, page_size=1000, order_direction='asc') paged_result_by_date("clicks", email_id, date, page, page_size, order_direction) end
email_opens(email_id="", date="", page=1, page_size=1000, order_direction='asc')
click to toggle source
Gets a paged list of subscribers who opened a given journey email
# File lib/createsend/journey.rb, line 23 def email_opens(email_id="", date="", page=1, page_size=1000, order_direction='asc') paged_result_by_date("opens", email_id, date, page, page_size, order_direction) end
email_recipients(email_id="", date="", page=1, page_size=1000, order_direction='asc')
click to toggle source
Gets a list of all recipients of a particular email within a journey
# File lib/createsend/journey.rb, line 18 def email_recipients(email_id="", date="", page=1, page_size=1000, order_direction='asc') paged_result_by_date("recipients", email_id, date, page, page_size, order_direction) end
email_unsubscribes(email_id="", date="", page=1, page_size=1000, order_direction='asc')
click to toggle source
Gets a paged result representing all subscribers who unsubscribed from a journey email
# File lib/createsend/journey.rb, line 33 def email_unsubscribes(email_id="", date="", page=1, page_size=1000, order_direction='asc') paged_result_by_date("unsubscribes", email_id, date, page, page_size, order_direction) end
summary()
click to toggle source
Get a full summary of a journey
# File lib/createsend/journey.rb, line 12 def summary response = get "/journeys/#{@journey_id}.json" Hashie::Mash.new(response) end
Private Instance Methods
get_journey_email_action(email_id, action, options = {})
click to toggle source
# File lib/createsend/journey.rb, line 54 def get_journey_email_action(email_id, action, options = {}) get "/journeys/email/#{email_id}/#{action}.json", options end
paged_result_by_date(resource, email_id, date, page, page_size, order_direction)
click to toggle source
# File lib/createsend/journey.rb, line 44 def paged_result_by_date(resource, email_id, date, page, page_size, order_direction) options = { :query => { :date => date, :page => page, :pagesize => page_size, :orderdirection => order_direction } } response = get_journey_email_action email_id, resource, options Hashie::Mash.new(response) end