class Sendgrid::API::Newsletter::MarketingEmails::Services

Public Instance Methods

add(marketing_email) click to toggle source

Create a new Marketing Email.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-add @param marketing_email [Entities::MarketingEmail] An Entities::MarketingEmail object. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/marketing_emails.rb, line 23
def add(marketing_email)
  perform_request(Entities::Response, 'newsletter/add.json', marketing_email.as_json)
end
delete(marketing_email) click to toggle source

Remove an existing Marketing Email.

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

# File lib/sendgrid/api/newsletter/marketing_emails.rb, line 62
def delete(marketing_email)
  params = { :name => extract_marketing_email(marketing_email) }
  perform_request(Entities::Response, 'newsletter/delete.json', params)
end
edit(marketing_email, newname = nil) click to toggle source

Edit an existing Marketing Email.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-edit @param marketing_email [Entities::MarketingEmail] An Entities::MarketingEmail object. @param newname [String] The new name for the Marketing Email being edited. Optional. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/marketing_emails.rb, line 33
def edit(marketing_email, newname = nil)
  params = marketing_email.as_json
  params.merge!(:newname => newname) if newname
  perform_request(Entities::Response, 'newsletter/edit.json', params)
end
get(marketing_email) click to toggle source

Retrieve the contents of an existing Marketing Email.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-get @param marketing_email [String, Entities::MarketingEmail] An existing marketing email name or Entities::MarketingEmail object. @return [Entities::MarketingEmail] An Entities::MarketingEmail object.

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

Retrieve a list of all existing Marketing Email.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-list @return [Array<Entities::MarketingEmail>] An array of Entities::MarketingEmail objects.

# File lib/sendgrid/api/newsletter/marketing_emails.rb, line 53
def list
  perform_request(Entities::MarketingEmail, 'newsletter/list.json')
end