class CreateSend::Administrator
Represents an administrator and associated functionality.
Attributes
email_address[R]
Public Class Methods
add(auth, email_address, name)
click to toggle source
Adds an administrator to the account.
# File lib/createsend/administrator.rb, line 20 def self.add(auth, email_address, name) options = { :body => { :EmailAddress => email_address, :Name => name }.to_json } cs = CreateSend.new auth response = cs.cs_post "/admins.json", options Hashie::Mash.new(response) end
get(auth, email_address)
click to toggle source
Gets an administrator by email address.
# File lib/createsend/administrator.rb, line 12 def self.get(auth, email_address) options = { :query => { :email => email_address } } cs = CreateSend.new auth response = cs.cs_get "/admins.json", options Hashie::Mash.new(response) end
new(auth, email_address)
click to toggle source
Calls superclass method
# File lib/createsend/administrator.rb, line 6 def initialize(auth, email_address) @email_address = email_address super end
Public Instance Methods
delete()
click to toggle source
Deletes this administrator from the account.
Calls superclass method
# File lib/createsend/administrator.rb, line 44 def delete options = { :query => { :email => @email_address } } super '/admins.json', options end
update(new_email_address, name)
click to toggle source
Updates the administator details.
# File lib/createsend/administrator.rb, line 31 def update(new_email_address, name) options = { :query => { :email => @email_address }, :body => { :EmailAddress => new_email_address, :Name => name }.to_json } put '/admins.json', options # Update @email_address, so this object can continue to be used reliably @email_address = new_email_address end