Merge pull request #90 from sendwithus/an-88919984186-template-data-support

jemeric · web-flow · commit 6e1d28eaa950 · 2025-06-05T09:37:39.000-07:00
Add support for template_data optional fields for template operations
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 4.5.0
+- Add optional `template_data` fields to template calls
+
 ## 4.4.0
 - **[#88](https://github.com/sendwithus/sendwithus_ruby/pull/88) Fix problematic `render` implementation.** `template_data` serves two purposes, defining template data and specifying the optional API parameter for `locale`. Previously, `locale` would be stripped out of `template_data` in the API request, preventing users from specifying variables named `locale` in their own template data.
 
diff --git a/lib/send_with_us/api.rb b/lib/send_with_us/api.rb
@@ -160,14 +160,15 @@ def render(template_id, version_id = nil, template_data = {}, strict = false)
       SendWithUs::ApiRequest.new(@configuration).post(:'render', payload)
     end
 
-    def create_template(name, subject, html, text, preheader='', amp_html='')
+    def create_template(name, subject, html, text, preheader='', amp_html='', template_data={})
       payload = {
         name: name,
         subject: subject,
         html: html,
         text: text,
         preheader: preheader,
-        amp_html: amp_html
+        amp_html: amp_html,
+        template_data: template_data
       }
 
       payload = payload.to_json
@@ -272,28 +273,30 @@ def get_template_version(template_id, version_id)
       SendWithUs::ApiRequest.new(@configuration).get(endpoint)
     end
 
-    def update_template_version(template_id, version_id, name, subject, html, text, preheader='', amp_html='')
+    def update_template_version(template_id, version_id, name, subject, html, text, preheader='', amp_html='', template_data={})
       payload = {
         name: name,
         subject: subject,
         html: html,
         text: text,
         preheader: preheader,
-        amp_html: amp_html
+        amp_html: amp_html,
+        template_data: template_data
       }
 
       endpoint = "templates/#{template_id}/versions/#{version_id}"
       SendWithUs::ApiRequest.new(@configuration).put(endpoint, payload.to_json)
     end
 
-    def create_template_version(template_id, name, subject, html, text, preheader='', amp_html='')
+    def create_template_version(template_id, name, subject, html, text, preheader='', amp_html='', template_data={})
       payload = {
         name: name,
         subject: subject,
         html: html,
         text: text,
         preheader: preheader,
-        amp_html: amp_html
+        amp_html: amp_html,
+        template_data: template_data
       }
 
       endpoint = "templates/#{template_id}/versions"
diff --git a/lib/send_with_us/version.rb b/lib/send_with_us/version.rb
@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '4.4.0'
+  VERSION = '4.5.0'
 end
diff --git a/test/lib/send_with_us/api_request_test.rb b/test/lib/send_with_us/api_request_test.rb
@@ -21,7 +21,8 @@ def build_objects
       :name => 'Test Template '.concat(Random.new.rand(100000).to_s),
       :id => 'test_fixture_1',
       :preheader => 'Test preheader',
-      :amp_html => '<html><head></head><body>AMP HTML</body></html>'
+      :amp_html => '<html><head></head><body>AMP HTML</body></html>',
+      :template_data => {data: 'I AM DATA'}
     }
   end
 
@@ -261,7 +262,8 @@ def test_update_template_version_with_optional_fields
       @template[:html],
       'sample text payload',
       preheader=@template[:preheader],
-      amp_html=@template[:amp_html]
+      amp_html=@template[:amp_html],
+      template_data=@template[:template_data]
     )
 
     assert_instance_of( Net::HTTPOK, result )
@@ -289,7 +291,8 @@ def test_create_template_version_with_optional_fields
       @template[:html],
       'sample text payload',
       preheader=@template[:preheader],
-      amp_html=@template[:amp_html]
+      amp_html=@template[:amp_html],
+      template_data=@template[:template_data]
     )
 
     assert_instance_of( Net::HTTPOK, result )
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -5,6 +5,7 @@
 
 require 'rubygems'
 require 'bundler'
+MiniTest = Minitest unless defined?(MiniTest)
 require "mocha/minitest"
 
 begin
