Class: Sendgrid::API::Newsletter::Recipients::Services

Inherits:

Service

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

Includes:

Utils

Defined in:

lib/sendgrid/api/newsletter/recipients.rb

Instance Attribute Summary

Attributes inherited from Service

#resource

Instance Method Summary

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

  Assign a List to a Marketing Email.

• #delete(list, marketing_email) ⇒ Entities::Response

  Remove assigned lists from Marketing Email.

• #get(marketing_email) ⇒ Array<Entities::List>

  Get all lists assigned to a particular Marketing Email.

Methods inherited from Service

#initialize, #perform_request

Constructor Details

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

Instance Method Details

#add(list, marketing_email) ⇒ Entities::Response

Assign a List to a Marketing Email.

Parameters:

• list (String, Entities::List) —

  A list name or Entities::List object.

• marketing_email (String, Entities::MarketingEmail) —

  A 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/recipients.html#-add

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

Remove assigned lists from Marketing Email.

Parameters:

• list (String, Entities::List) —

  A list name or Entities::List object.

• marketing_email (String, Entities::MarketingEmail) —

  A 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/recipients.html#-delete

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

Get all lists assigned to a particular Marketing Email.

Parameters:

• marketing_email (String, Entities::MarketingEmail) —

  A marketing email name or Entities::MarketingEmail object.

Returns:

• (Array<Entities::List>) —

  An array of Entities::List objects.

See Also:

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

# 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