class Dashamail::List
Mailing list representation class
Constants
- FIELDS
Attributes
raw[R]
Public Class Methods
new(connection, doc)
click to toggle source
Initialize new list instance
@param connection [Pachkin::Connection] Active connection @param doc [Hash] API object data
Calls superclass method
# File lib/dashamailrb/list.rb, line 29 def initialize(connection, doc) super(connection, doc) FIELDS.each do |field| instance_variable_set :"@#{field}", doc[field.to_s] end end
Public Instance Methods
add_member(params)
click to toggle source
Invokes 'lists.add_memner' method
@param params [Hash] Params to be passed @return [Dashamail::Member] New member instance
# File lib/dashamailrb/list.rb, line 52 def add_member(params) added = connection.call_method('lists.add_member', params.merge(id_params)) get_members(added).first end
get_members(params = {})
click to toggle source
Invokes 'lists.get_members' API method to retreive list members
@param params [Hash] Params to be passed @return [Array] Array of Dashamail::Members instances
# File lib/dashamailrb/list.rb, line 40 def get_members(params = {}) connection.call_method('lists.get_members', params.merge(id_params)).map {|member| Dashamail::Member.new(connection, member)} end
Also aliased as: members
unsubscribe_member(params)
click to toggle source
Invokes 'lists.unsubscribe_member' API method
@param params [Hash] Params to be passed @return [Fixnum] Count of unsubscribed members
# File lib/dashamailrb/list.rb, line 61 def unsubscribe_member(params) connection.call_method('lists.unsubscribe_member', params.merge(id_params))['unsubscribed'] end
Private Instance Methods
id_params()
click to toggle source
# File lib/dashamailrb/list.rb, line 67 def id_params {list_id: id} end