notifications-node-client 8.0.0 → 8.1.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 8.1.0 - 2024-05-09
+
+* The `sendEmail` function can now be passed `oneClickUnsubscribeURL` as an optional argument.
+
 ## 8.0.0 - 2023-12-27
 
 * Remove the default `is_csv` boolean parameter from `prepareUpload`. This method now accepts a file and an options map with the following options. For more specific information please read the documentation.

package/client/notification.js

@@ -23,10 +23,11 @@ function NotifyClient() {
  * @param {Object} personalisation
  * @param {String} reference
  * @param {String} replyToId
+ * @param {String} oneClickUnsubscribeURL
  *
  * @returns {Object}
  */
-function createNotificationPayload(type, templateId, to, personalisation, reference, replyToId) {
+function createNotificationPayload(type, templateId, to, personalisation, reference, replyToId, oneClickUnsubscribeURL) {
 
   var payload = {
     template_id: templateId
@@ -53,6 +54,10 @@ function createNotificationPayload(type, templateId, to, personalisation, refere
     payload.sms_sender_id = replyToId;
   }
 
+  if (oneClickUnsubscribeURL && type == 'email') {
+    payload.one_click_unsubscribe_url = oneClickUnsubscribeURL;
+  }
+
   return payload;
 }
 
@@ -144,16 +149,17 @@ Object.assign(NotifyClient.prototype, {
    */
   sendEmail: function (templateId, emailAddress, options) {
     options = options || {};
-    var err = checkOptionsKeys(['personalisation', 'reference', 'emailReplyToId'], options)
+    var err = checkOptionsKeys(['personalisation', 'reference', 'emailReplyToId', 'oneClickUnsubscribeURL'], options)
     if (err) {
       return Promise.reject(err);
     }
     var personalisation = options.personalisation || undefined,
       reference = options.reference || undefined,
-      emailReplyToId = options.emailReplyToId || undefined;
+      emailReplyToId = options.emailReplyToId || undefined,
+      oneClickUnsubscribeURL = options.oneClickUnsubscribeURL || undefined;
 
     return this.apiClient.post('/v2/notifications/email',
-      createNotificationPayload('email', templateId, emailAddress, personalisation, reference, emailReplyToId));
+      createNotificationPayload('email', templateId, emailAddress, personalisation, reference, emailReplyToId, oneClickUnsubscribeURL));
   },
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -36,4 +36,3 @@
     "standard-markdown": "5.0.1"
   }
 }
-

package/spec/integration/schemas/v2/definitions.json

@@ -25,7 +25,8 @@
     "properties": {
         "body": {"type": "string"},
         "from_email": {"type": "string", "format": "email_address"},
-        "subject": {"type": "string"}
+        "subject": {"type": "string"},
+        "one_click_unsubscribe_url": {"type": ["string", "null"], "format": "uri"}
     },
     "required": ["body", "from_email", "subject"]
   },

package/spec/integration/test.js

@@ -36,6 +36,7 @@ describer('notification api with a live service', function () {
   let letterNotificationId;
   const personalisation = { name: 'Foo' };
   const clientRef = 'client-ref';
+  const oneClickUnsubscribeURL = 'https://www.example.com';
   const email = process.env.FUNCTIONAL_TEST_EMAIL;
   const phoneNumber = process.env.FUNCTIONAL_TEST_NUMBER;
   const letterContact = {
@@ -88,6 +89,22 @@ describer('notification api with a live service', function () {
         expect(response.data).to.be.jsonSchema(postEmailNotificationResponseJson);
         response.data.content.body.should.equal('Hello Foo\r\n\r\nFunctional test help make our world a better place');
         response.data.content.subject.should.equal('Functional Tests are good');
+        should.equal(response.data.content.one_click_unsubscribe_url, null);
+        response.data.reference.should.equal(clientRef);
+        emailNotificationId = response.data.id;
+      })
+    });
+
+    it('send email notification with unsubscribe link', () => {
+      var postEmailNotificationResponseJson = require('./schemas/v2/POST_notification_email_response.json'),
+        options = {personalisation: personalisation, reference: clientRef, oneClickUnsubscribeURL: oneClickUnsubscribeURL};
+
+      return notifyClient.sendEmail(emailTemplateId, email, options).then((response) => {
+        response.status.should.equal(201);
+        expect(response.data).to.be.jsonSchema(postEmailNotificationResponseJson);
+        response.data.content.body.should.equal('Hello Foo\r\n\r\nFunctional test help make our world a better place');
+        response.data.content.subject.should.equal('Functional Tests are good');
+        response.data.content.one_click_unsubscribe_url.should.equal(oneClickUnsubscribeURL);
         response.data.reference.should.equal(clientRef);
         emailNotificationId = response.data.id;
       })

package/spec/notification.js

@@ -92,6 +92,31 @@ describe('notification api', () => {
       });
     });
 
+    it('should send an email with a one click unsubscribe URL', () => {
+
+      let email = 'me@example.com',
+        templateId = '123',
+        options = {
+          personalisation: {foo: 'bar'},
+          oneClickUnsubscribeURL: '456',
+        },
+        data = {
+          template_id: templateId,
+          email_address: email,
+          personalisation: options.personalisation,
+          one_click_unsubscribe_url: options.oneClickUnsubscribeURL
+        };
+
+      notifyAuthNock
+      .post('/v2/notifications/email', data)
+      .reply(200, {hooray: 'bkbbk'});
+
+      return notifyClient.sendEmail(templateId, email, options)
+      .then((response) => {
+        expect(response.status).to.equal(200);
+      });
+    });
+
     it('should send an email with document upload', () => {
       let email = 'dom@example.com',
         templateId = '123',