notifications-node-client - npm Package Versions

5.0.1 - 2020-11-18

Changed

Remove unintentional global nature of variable version

5.0.0 - 2020-09-02

Changed

We have replaced the use of the npm request-promise package with axios as the npm request package has been deprecated. This makes the following breaking changes:

1. The response object returned by a successful API call is now in the form of an axios response. This has a different interface to a request response. For example:

   • response.body becomes response.data
   • response.statusCode becomes response.status

2. The err object returned by an unsuccessful API call has a different interface. For example, err.error becomes err.response.data. See the axios documentation for further details on error handling.

3. To configure the use of a proxy you should pass the proxy configuration as an object rather than a URL. For details, see the axios client.

4. We now return native promises rather than bluebird promises. You will not need to make any changes unless you are using some of the additional methods found on bluebird promises that do not exist on native promises.

4.9.0 - 2020-08-19

Changed

• Added letter_contact_block to the responses for getTemplateById, getTemplateByIdAndVersion and getAllTemplates.

4.8.0 - 2020-06-18

Changed

• Add support for an optional isCsv parameter in the prepareUpload function. This fixes a bug when sending a CSV file by email. This ensures that the file is downloaded as a CSV rather than a TXT file.

[4.7.3] - 2020-04-03

Changed

• Remove __dirname global call from api client

[4.7.2] - 2020-01-31

Changed

• Add homepage to package.json

[4.7.1] - 2020-01-27

Changed

• Refer to files, not documents, in error messages

[4.7.0] - 2019-11-01

Changed

• Add notifyClient.getPdfForLetterNotification(notificationId)
  • Returns a Buffer with pdf data
  • Will raise a BadRequestError if the PDF is not available

[4.6.0] - 2019-02-01

Changed

• Added an optional postage argument to sendPrecompiledLetter

[4.5.2] - 2018-11-05

Changed

• Moved documentation to https://docs.notifications.service.gov.uk/node.html (generated from DOCUMENTATION.md)