class Sendgrid::API::Newsletter::Lists::Services

Public Instance Methods

add(list) click to toggle source

Create a new Recipient List.

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

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

Remove a Recipient List from your account.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/lists.html#-delete @param list [String, Entities::List] An existing list name or Entities::List object. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/lists.rb, line 54
def delete(list)
  params = { :list => extract_listname(list) }
  perform_request(Entities::Response, 'newsletter/lists/delete.json', params)
end
edit(list, newlist) click to toggle source

Rename a Recipient List.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/lists.html#-edit @param list [String, Entities::List] An existing list name or Entities::List object. @param newlist [String, Entities::List] A new list name or Entities::List object. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/lists.rb, line 34
def edit(list, newlist)
  params = { :list => extract_listname(list), :newlist => extract_listname(newlist) }
  perform_request(Entities::Response, 'newsletter/lists/edit.json', params)
end
get(list = nil) click to toggle source

List all Recipient Lists on your account, or check if a particular List exists.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/lists.html#-get @param list [String, Entities::List] An existing list name or Entities::List object. Optional. @return [Array<Entities::List>] An array of Entities::List objects.

# File lib/sendgrid/api/newsletter/lists.rb, line 44
def get(list = nil)
  params = { :list => extract_listname(list) } if list
  perform_request(Entities::List, 'newsletter/lists/get.json', params || {})
end