[4.4.0] - 2018-09-05

Changed

• Added instructions for uploading a document to be linked to from an email notification.
  • Created a helper function prepareUpload as a part of this development. This function encodes the document that is to be uploaded with base64 and returns a dictionary with prepared document as a value (the way our API is prepared to receive it). It also checks if the provided file is not larger than 2MB. The function throws an error if the file is too big.

[4.3.0] - 2018-09-04

• Added name to the response for getTemplateById() and getTemplateByIdAndVersion()
  • These functions now return the name of the template as set in Notify

[4.2.0] - 2018-07-24

Changed

• Added created_by_name to the response for .getNotificationById() and .getNotifications():
  • If the notification was sent manually this will be the name of the sender. If the notification was sent through the API this will be null.

[4.1.0] - 2017-11-23

Changed

• Added new method:
  • getReceivedTexts - get one page of text messages (250) per call

[4.0.0] - 2017-11-07

Changed

• Updated sendSms, sendEmail and sendLetter to take an options object as a parameter.
  • personalisation, reference, smsSenderId and emailReplyToId now need to be passed to these functions inside options.
• Removed the unused Crypto dependency

[3.5.0] - 2017-11-01

Changed

• Updated sendSms method with optional argument:
  • smsSenderId - specify the identifier of the sms sender (optional)

[3.2.0] - 2017-09-22

Changed

• Added new method:
  • setProxy(proxyUrl) - specify the URL of a proxy for the client to use (optional)

[3.1.0] - 2017-05-10

Changed

• Added new methods for managing templates:

  • getTemplateById - retrieve a single template
  • getTemplateByIdAndVersion - retrieve a specific version for a desired template
  • getAllTemplates - retrieve all templates (can filter by type)
  • previewTemplateById - preview a template with personalisation applied

• Update README to describe how to catch errors

[3.0.0] - 2016-12-16

Changed

• Using v2 of the notification-api.

• Update to notifyClient.sendSms():

  • Added reference: an optional identifier you generate if you don’t want to use Notify’s id. It can be used to identify a single notification or a batch of notifications.
  • Updated method signature:

notifyClient.sendSms(templateId, phoneNumber, personalisation, reference);

 * Where `personalisation` and `reference` can be `undefined`.

• Update to notifyClient.sendEmail():
  • Added reference: an optional identifier you generate if you don’t want to use Notify’s id. It can be used to identify a single notification or a batch of notifications.
  • Updated method signature:

notifyClient.sendEmail(templateId, emailAddress, personalisation, reference);

 * Where `personalisation` and `reference` can be `undefined`.

• NotificationClient.getAllNotifications()
  • Notifications can now be filtered by reference and olderThanId, see the README for details.
  • Updated method signature:

notifyClient.getNotifications(templateType, status, reference, olderThanId);

 * Each one of these parameters can be `undefined`

Changelog not recorded - please see pull requests on github.