Class: Iterable::EmailTemplates

Inherits:
ApiResource show all
Defined in:
lib/iterable/email_templates.rb

Overview

Interact with /templates/email API endpoints

Examples:

Creating email templates endpoint object

# With default config
templates = Iterable::EmailTemplates.new
templates.get

# With custom config
conf = Iterable::Config.new(token: 'new-token')
templates = Iterable::EmailTemplates.new(config)

Instance Attribute Summary

Attributes inherited from ApiResource

#conf

Instance Method Summary collapse

Methods inherited from ApiResource

#default_config, default_config, #initialize

Constructor Details

This class inherits a constructor from Iterable::ApiResource

Instance Method Details

#get(template_id, params = {}) ⇒ Iterable::Response

Get an email template

Parameters:

  • template_id (String|Integer) —

    An email template ID

  • params (Hash) (defaults to: {}) —

    Additional params to use such as locale

Returns:



23
24
25
26
 
# File 'lib/iterable/email_templates.rb', line 23

def get(template_id, params = {})
  params['templateId'] = template_id
  Iterable.request(conf, '/templates/email/get', params).get
end

#update(template_id, attrs = {}) ⇒ Iterable::Response

Update an email template

Parameters:

  • template_id (String|Integer) —

    An email template ID

  • attrs (Hash) (defaults to: {}) —

    Update attributes

Returns:



36
37
38
39
 
# File 'lib/iterable/email_templates.rb', line 36

def update(template_id, attrs = {})
  attrs['templateId'] = template_id
  Iterable.request(conf, '/templates/email/update').post(attrs)
end

#upsert(client_template_id, attrs = {}) ⇒ Iterable::Response

Upsert an email template by client template ID

Parameters:

  • client_template_id (String) —

    A client template id to use or create

  • attrs (Hash) (defaults to: {}) —

    Update attributes

Returns:



49
50
51
52
 
# File 'lib/iterable/email_templates.rb', line 49

def upsert(client_template_id, attrs = {})
  attrs['clientTemplateId'] = client_template_id
  Iterable.request(conf, '/templates/email/upsert').post(attrs)
end