Add Dynamic Template Support

[thinkingserious]

Issue Summary

On 7/24/2018, our team publicly launched dynamic content for transactional templates. It is now available for all customers sending over v3 of our Mail Send API. Iterate over lists, handle conditionals and more, thanks to native support for a subset of Handlebars syntax!

More information can be found in our blog post announcement.

You can currently use this feature by manually creating the request body as shown here.

Now, we need to create helper code and examples for this SDK.

Acceptance Criteria

• Implement a helper similar to what we have for the legacy templates
• Update the USE_CASES.md example to demonstrate the new Dynamic Templates using the helper and re-name the current example to Legacy

Documentation

• Reference Implementation
• How to Send an Email With Dynamic Transactional Templates
• Using Handlebars
• Interactive API Docs

[thinkingserious]

Please see #300 for WIP

[metaskills]

I'd like to point out the the docs and the article have the template_id in the wrong spot. It should be outside the personalizations array at the root.

[thinkingserious]

Hi @metaskills,

Are you referring this documentation? If so, it looks like a fix will be deployed soon.

Thanks!

With Best Regards,

Elmer

[metaskills]

Yes, I found that template_id is in the wrong spot there.

[thinkingserious]

Thanks for confirming @metaskills. I'm double checking with the docs team to make sure the fix is deployed.

[heindrik]

Hi all,

Has the gem been updated with the new helper methods for dynamic template? I am asking cause I am using gem version 5.2 and I am getting the following error

Exception encountered: NoMethodError - undefined method `add_dynamic_template_data' for #<SendGrid::Personalization:0x00005615d7b5ae08>

[thinkingserious]

Not yet @heindrik, please follow this page for updates or you can subscribe to our release notification emails here. Thanks!

[hiroshi]

For those who want to use helpers for other parts

mail = SendGrid::Mail.new
...
personalization = SendGrid::Personalization.new
personalization.add_to(SendGrid::Email.new(email: user_email))
mail.add_personalization(personalization)
...
body = mail.to_json
# TODO: use helper after the issue resolved https://github.com/sendgrid/sendgrid-ruby/issues/301             
body['personalizations'][0]['dynamic_template_data'] = {                                                   
  foo: 'bar'
}                                                                                                          
sg_client = SendGrid::API.new(api_key: YOUR_API_KEY).client
resp = sg_client.mail._('send').post(request_body: body)
unless resp.status_code == '202'
  raise "Error response from sendgrid API: status_code: #{resp.status_code}, body: #{resp.body}"
end

[Davidslv]

I can't understand how it can take so long to release this, specially when the information given is that we are waiting because of other languages.
Anyway, I'm using the code straight from master branch which includes the dynamic template data.
There was no need to make us wait so long.

[devsi]

Docs are still out of date. I had to search for this PR and https://github.com/sendgrid/sendgrid-ruby/pull/300 this related link to realize I couldn't use "substitutions". How is this a year out of date and not in the docs yet?!

[courtsimas]

It blows my mind that a company as large as SendGrid still hasn't updated their docs to reflect this, nor have they updated this gem to work with their new API.

[evandertino]

I think this issue should be closed, dynamic templates work. See https://github.com/sendgrid/sendgrid-ruby/blob/main/examples/helpers/mail/example.rb

[childish-sambino]

Example here as well: https://github.com/sendgrid/sendgrid-ruby/blob/main/use-cases/transactional-templates.md#with-mail-helper-class

Closing.

Please open a new ticket to track any additional docs work needed.