Class: Sendgrid::API::Newsletter::Categories::Services

Inherits:

Service

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

Includes:

Utils

Defined in:

lib/sendgrid/api/newsletter/categories.rb

Instance Attribute Summary

Attributes inherited from Service

#resource

Instance Method Summary

• #add(marketing_email, category) ⇒ Entities::Response

  Assign a Category to an existing Marketing Email.

• #create(category) ⇒ Entities::Response

  Create a new Category.

• #list ⇒ Array<Entities::Category>

  List all categories.

• #remove(marketing_email, category) ⇒ Entities::Response

  Remove specific categories, or all categories from a 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, category) ⇒ Entities::Response

Assign a Category to an existing Marketing Email.

Parameters:

• marketing_email (String, Entities::MarketingEmail) —

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

• category (String, Entities::Category) —

  A category name or Entities::Category object.

Returns:

• (Entities::Response) —

  An Entities::Response object.

See Also:

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

# File 'lib/sendgrid/api/newsletter/categories.rb', line 34

def add(marketing_email, category)
  params = { :name => extract_marketing_email(marketing_email), :category => extract_category(category) }
  perform_request(Entities::Response, 'newsletter/category/add.json', params)
end

#create(category) ⇒ Entities::Response

Create a new Category.

Parameters:

• category (String, Entities::Category) —

  A category name or Entities::Category object.

Returns:

• (Entities::Response) —

  An Entities::Response object.

See Also:

• http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/categories.html#-create

# File 'lib/sendgrid/api/newsletter/categories.rb', line 23

def create(category)
  params = { :category => extract_category(category) }
  perform_request(Entities::Response, 'newsletter/category/create.json', params)
end

#list ⇒ Array<Entities::Category>

List all categories.

Returns:

• (Array<Entities::Category>) —

  An array of Entities::Category objects.

See Also:

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

# File 'lib/sendgrid/api/newsletter/categories.rb', line 54

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

#remove(marketing_email, category) ⇒ Entities::Response

Remove specific categories, or all categories from a Marketing Email.

Parameters:

• marketing_email (String, Entities::MarketingEmail) —

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

• category (String, Entities::Category) —

  A category name or Entities::Category object.

Returns:

• (Entities::Response) —

  An Entities::Response object.

See Also:

• http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/categories.html#-remove

# File 'lib/sendgrid/api/newsletter/categories.rb', line 45

def remove(marketing_email, category)
  params = { :name => extract_marketing_email(marketing_email), :category => extract_category(category) }
  perform_request(Entities::Response, 'newsletter/category/remove.json', params)
end