Class: Pechkin::List
Overview
Mailing list representation class
Constant Summary collapse
- FIELDS =
[ :id, :state, :count_active, :count_all, :name, :description, :company, :abuse_name, :phone, :address, :city, :url ]
Instance Attribute Summary collapse
-
#raw ⇒ Object
readonly
Returns the value of attribute raw.
Instance Method Summary collapse
-
#add_member(params) ⇒ Pechkin::Member
Invokes ‘lists.add_memner’ method.
-
#get_members(params = {}) ⇒ Array
(also: #members)
Invokes ‘lists.get_members’ API method to retreive list members.
-
#initialize(connection, doc) ⇒ List
constructor
Initialize new list instance.
-
#unsubscribe_member(params) ⇒ Fixnum
Invokes ‘lists.unsubscribe_member’ API method.
Constructor Details
#initialize(connection, doc) ⇒ List
Initialize new list instance
29 30 31 32 33 34 |
# File 'lib/pechkinrb/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 |
Instance Attribute Details
#raw ⇒ Object (readonly)
Returns the value of attribute raw.
4 5 6 |
# File 'lib/pechkinrb/list.rb', line 4 def raw @raw end |
Instance Method Details
#add_member(params) ⇒ Pechkin::Member
Invokes ‘lists.add_memner’ method
52 53 54 55 |
# File 'lib/pechkinrb/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 = {}) ⇒ Array Also known as: members
Invokes ‘lists.get_members’ API method to retreive list members
40 41 42 |
# File 'lib/pechkinrb/list.rb', line 40 def get_members(params = {}) connection.call_method('lists.get_members', params.merge(id_params)).map {|member| Pechkin::Member.new(connection, member)} end |
#unsubscribe_member(params) ⇒ Fixnum
Invokes ‘lists.unsubscribe_member’ API method
61 62 63 |
# File 'lib/pechkinrb/list.rb', line 61 def unsubscribe_member(params) connection.call_method('lists.unsubscribe_member', params.merge(id_params))['unsubscribed'] end |