class Sendgrid::API::Newsletter::Recipients::Services

Public Instance Methods

add(list, marketing_email) click to toggle source

Assign a List to a Marketing Email.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/recipients.html#-add @param list [String, Entities::List] A list name or Entities::List object. @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/recipients.rb, line 24
def add(list, marketing_email)
  params = { :list => extract_listname(list), :name => extract_marketing_email(marketing_email) }
  perform_request(Entities::Response, 'newsletter/recipients/add.json', params)
end
delete(list, marketing_email) click to toggle source

Remove assigned lists from Marketing Email.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/recipients.html#-delete @param list [String, Entities::List] A list name or Entities::List object. @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/recipients.rb, line 45
def delete(list, marketing_email)
  params = { :list => extract_listname(list), :name => extract_marketing_email(marketing_email) }
  perform_request(Entities::Response, 'newsletter/recipients/delete.json', params)
end
get(marketing_email) click to toggle source

Get all lists assigned to a particular Marketing Email.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/recipients.html#-get @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object. @return [Array<Entities::List>] An array of Entities::List objects.

# File lib/sendgrid/api/newsletter/recipients.rb, line 34
def get(marketing_email)
  params = { :name => extract_marketing_email(marketing_email) }
  perform_request(Entities::List, 'newsletter/recipients/get.json', params)
end