Class: Sendgrid::API::Newsletter::MarketingEmails::Services

Inherits:

Service

• Object
• Service
• Sendgrid::API::Newsletter::MarketingEmails::Services

Includes:

Utils

Defined in:

lib/sendgrid/api/newsletter/marketing_emails.rb

Instance Attribute Summary

Attributes inherited from Service

#resource

Instance Method Summary

• #add(marketing_email) ⇒ Entities::Response

  Create a new Marketing Email.

• #delete(marketing_email) ⇒ Entities::Response

  Remove an existing Marketing Email.

• #edit(marketing_email, newname = nil) ⇒ Entities::Response

  Edit an existing Marketing Email.

• #get(marketing_email) ⇒ Entities::MarketingEmail

  Retrieve the contents of an existing Marketing Email.

• #list ⇒ Array<Entities::MarketingEmail>

  Retrieve a list of all existing Marketing Email.

Methods inherited from Service

#initialize, #perform_request

Constructor Details

This class inherits a constructor from Sendgrid::API::Service

Instance Method Details

#add(marketing_email) ⇒ Entities::Response

Create a new Marketing Email.

Parameters:

• marketing_email (Entities::MarketingEmail) —

  An Entities::MarketingEmail object.

Returns:

• (Entities::Response) —

  An Entities::Response object.

See Also:

• http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-add

# 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) ⇒ Entities::Response

Remove an existing Marketing Email.

Parameters:

• marketing_email (String, Entities::MarketingEmail) —

  An existing marketing email name or Entities::MarketingEmail object.

Returns:

• (Entities::Response) —

  An Entities::Response object.

See Also:

• http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-delete

# 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) ⇒ Entities::Response

Edit an existing Marketing Email.

Parameters:

• marketing_email (Entities::MarketingEmail) —

  An Entities::MarketingEmail object.

• newname (String) (defaults to: nil) —

  The new name for the Marketing Email being edited. Optional.

Returns:

• (Entities::Response) —

  An Entities::Response object.

See Also:

• http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-edit

# 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) ⇒ Entities::MarketingEmail

Retrieve the contents of an existing Marketing Email.

Parameters:

• marketing_email (String, Entities::MarketingEmail) —

  An existing marketing email name or Entities::MarketingEmail object.

Returns:

• (Entities::MarketingEmail) —

  An Entities::MarketingEmail object.

See Also:

• http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-get

# 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 ⇒ Array<Entities::MarketingEmail>

Retrieve a list of all existing Marketing Email.

Returns:

• (Array<Entities::MarketingEmail>) —

  An array of Entities::MarketingEmail objects.

See Also:

• http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-list

# File 'lib/sendgrid/api/newsletter/marketing_emails.rb', line 53

def list
  perform_request(Entities::MarketingEmail, 'newsletter/list.json')
end