Merge pull request #19 from mell0kat/set-batch-id

Adds setBatchId method

Author: SendGrid's DX Team

examples/example.js

@@ -58,6 +58,10 @@ header.setFilters({
 // You can set the send_at scheduling param using an UNIX timestamp.
 header.setSendAt(1409348513);
 
+// setBatchId
+// You can set the batch_id scheduling param using a string.
+header.setBatchId('apples');
+
 // setSendEachAt
 // You can set the send_each_at scheduling param using a list of UNIX timestamps.
 //header.setSendEachAt([1409348513, 14093485134]);
@@ -109,4 +113,4 @@ smtpTransport.sendMail(mailOptions, function(error, response) {
   } else {
     console.log("Message sent");
   }
-});
+});

lib/main.js

@@ -15,6 +15,7 @@ var smtpapi = function smtpapi(header) {
   this.header.section = header.section || {};
   this.header.filters = header.filters || {};
   this.header.send_at = header.send_at || '';
+  this.header.batch_id = header.batch_id || '';
   this.header.send_each_at = header.send_each_at || [];
   this.header.asm_group_id = header.asm_group_id || {};
   this.header.ip_pool = header.ip_pool || '';
@@ -97,6 +98,10 @@ smtpapi.prototype.setSendAt = function(send_at) {
   this.header.send_at = send_at;
 };
 
+smtpapi.prototype.setBatchId = function(batch_id) {
+  this.header.batch_id = batch_id;
+};
+
 smtpapi.prototype.setSendEachAt = function(send_each_at) {
   this.header.send_at = '';
   this.header.send_each_at = send_each_at

test/main.js

@@ -105,6 +105,11 @@ describe('smtapi', function() {
     header.jsonString().should.eql(t.set_send_at);
   });
 
+  it('setBatchId', function() {
+    header.setBatchId('apples');
+    header.jsonString().should.eql(t.set_batch_id);
+  });
+
   it('setSendAt', function() {
     header.setSendEachAt([1409348513, 1409348514, 1409348515]);
     header.jsonString().should.eql(t.set_send_each_at);

test/smtpapi_test_strings.json

@@ -15,6 +15,7 @@
   "add_filter": "{\"filters\":{\"footer\":{\"settings\":{\"text/html\":\"<strong>boo</strong>\"}}}}",
   "set_filters": "{\"filters\":{\"footer\":{\"setting\":{\"enable\":1,\"text/plain\":\"You can haz footers!\"}}}}",
   "set_send_at": "{\"send_at\":1409348513}",
+  "set_batch_id": "{\"batch_id\":\"apples\"}",
   "set_send_each_at": "{\"send_each_at\":[1409348513,1409348514,1409348515]}",
   "add_send_each_at": "{\"send_each_at\":[1409348513,1409348514,1409348515]}",
   "set_asm_group_id": "{\"asm_group_id\":123}",