notifications-node-client 5.0.0 → 5.1.1

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 5.1.1 - 2022-01-18
+
+Upgrade axios version from ^0.21.1 to ^0.25.0
+
+## 5.1.0 - 2020-12-30
+
+### Changed
+
+* Upgrade axios version from 0.19.2 to 0.21.1
+* Allow any compatible version of axios to be used (0.21.1 to <1.0.0)
+* Allow any compatible version of jsonwebtoken to be used (8.2.1 to <9.0.0)
+
+## 5.0.2 - 2020-11-20
+
+### Changed
+
+Correct incorrect description of parameter to be used by `NotifyClient.setProxy`
+
+## 5.0.1 - 2020-11-18
+
+### Changed
+
+Remove unintentional global nature of variable `version`
+
 ## 5.0.0 - 2020-09-02
 
 ### Changed

package/CONTRIBUTING.md

@@ -2,52 +2,58 @@
 
 Pull requests welcome.
 
-## Working on the client locally
+## Setting Up
 
-`npm install --save notifications-node-client`
+### Docker container
 
-## Tests
+This app uses dependencies that are difficult to install locally. In order to make local development easy, we run app commands through a Docker container. Run the following to set this up:
 
-There are unit and integration tests that can be run to test functionality of the client.
+```shell
+make bootstrap-with-docker
+```
 
-To run the unit tests:
+### `environment.sh`
+
+In the root directory of the repo, run:
+
+```
+notify-pass credentials/client-integration-tests > environment.sh
+```
+
+Unless you're part of the GOV.UK Notify team, you won't be able to run this command or the Integration Tests. However, the file still needs to exist - run `touch environment.sh` instead.
+
+## Tests
 
-`make test`
+There are unit and integration tests that can be run to test functionality of the client.
 
-## Integration Tests
+### Unit tests
 
-Before running the integration tests, please ensure that the environment variables are set up.
+To run the unit tests:
 
 ```
-export NOTIFY_API_URL="https://example.notify-api.url"
-export API_KEY="example_API_test_key"
-export FUNCTIONAL_TEST_NUMBER="valid mobile number"
-export FUNCTIONAL_TEST_EMAIL="valid email address"
-export EMAIL_TEMPLATE_ID="valid email_template_id"
-export SMS_TEMPLATE_ID="valid sms_template_id"
-export LETTER_TEMPLATE_ID="valid letter_template_id"
-export EMAIL_REPLY_TO_ID="valid email reply to id"
-export SMS_SENDER_ID="valid sms_sender_id - to test sending to a receiving number, so needs to be a valid number"
-export API_SENDING_KEY="API_team_key for sending a SMS to a receiving number"
-export INBOUND_SMS_QUERY_KEY="API_test_key to get received text messages - leave blank for local development as cannot test locally"
+make test-with-docker
 ```
 
+### Integration Tests
 
 To run the integration tests:
 
-`make integration-test`
-
-The integration tests are used to test the contract of the response to all the api calls, ensuring the latest version of notifications-api do not break the contract of the notifications-node-client.
+```
+make integration-test-with-docker
+```
 
-## Testing JavaScript examples in Markdown
+## Working on the client locally
 
-We automatically test that the JavaScript in the documentation examples matched [our linting standards](https://gds-way.cloudapps.digital/manuals/programming-languages/nodejs/#source-formatting-and-linting),
-this also catches some issues that could stop an example from running when copied.
+```
+npm install --save notifications-node-client
+```
 
-To test the JavaScript for syntax and linting errors run:
+## Testing JavaScript examples in Markdown
 
-`make markdown-standard-test`
+We automatically test that the JavaScript in the documentation examples matches [our linting standards](https://gds-way.cloudapps.digital/manuals/programming-languages/nodejs/#source-formatting-and-linting). This also catches some issues that could stop an example from running when copied.
 
-You can then fix some issues automatically by running:
+You can fix issues automatically by running:
 
-`make markdown-standard-test-fix`
+```
+npm run test:markdown:standard -- --fix
+```

package/DOCUMENTATION.md

@@ -2,9 +2,9 @@
 
 This documentation is for developers interested in using the GOV.UK Notify Node.js client to send emails, text messages or letters.
 
-# Set up the client
+## Set up the client
 
-## Install the client
+### Install the client
 
 Run the following in the command line:
 
@@ -12,7 +12,7 @@ Run the following in the command line:
 npm install --save notifications-node-client
 ```
 
-## Create a new instance of the client
+### Create a new instance of the client
 
 Add this code to your application:
 
@@ -24,7 +24,7 @@ var notifyClient = new NotifyClient(apiKey)
 
 To get an API key, [sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __API integration__ page. You can find more information in the [API keys](#api-keys) section of this documentation.
 
-### Connect through a proxy (optional)
+#### Connect through a proxy (optional)
 
 Add this code to your application:
 
@@ -39,13 +39,13 @@ notifyClient.setProxy(proxyConfig)
 
 where the `proxyConfig` should be an object supported by [axios](https://github.com/axios/axios).
 
-# Send a message
+## Send a message
 
 You can use GOV.UK Notify to send text messages, emails (including documents) and letters.
 
-## Send a text message
+### Send a text message
 
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -63,9 +63,9 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### templateId (required)
+##### templateId (required)
 
 To find the template ID:
 
@@ -79,7 +79,7 @@ For example:
 'f33517ff-2a88-4f6e-b855-c550268ce08a'
 ```
 
-#### phoneNumber (required)
+##### phoneNumber (required)
 
 The phone number of the recipient of the text message. This number can be a UK or international number. For example:
 
@@ -87,7 +87,7 @@ The phone number of the recipient of the text message. This number can be a UK o
 '+447900900123'
 ```
 
-#### personalisation (required)
+##### personalisation (required)
 
 If a template has placeholder fields for personalised information such as name or reference number, you must provide their values in an `object`. For example:
 
@@ -98,7 +98,7 @@ If a template has placeholder fields for personalised information such as name o
 }
 ```
 
-#### reference (required)
+##### reference (required)
 
 A unique identifier you create. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. If you do not have a reference, you must pass in an empty string or `null`. For example:
 
@@ -106,7 +106,7 @@ A unique identifier you create. This reference identifies a single unique notifi
 'your_reference_here'
 ```
 
-#### smsSenderId (optional)
+##### smsSenderId (optional)
 
 A unique identifier of the sender of the text message notification. For example:
 
@@ -127,7 +127,7 @@ In this screen, you can either:
 
 You can leave out this argument if your service only has one text message sender, or if you want to use the default sender.
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -152,13 +152,13 @@ If you are using the [test API key](#test), all your messages come back with a `
 
 All messages sent using the [team and guest list](#team-and-guest-list) or [live](#live) keys appear on your dashboard.
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
 |err.response.data.status_code|err.response.data.errors|How to fix|
 |:---|:---|:---|
-|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`]}`|Use the correct type of [API key](#api-keys)|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`}]`|Use the correct type of [API key](#api-keys)|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"`<br>`}]`|Your service cannot send this notification in [trial mode](https://www.notifications.service.gov.uk/features/using-notify#trial-mode)|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
@@ -166,9 +166,9 @@ If the request is not successful, the promise fails with an `err`.
 |`429`|`[{`<br>`"error": "TooManyRequestsError",`<br>`"message": "Exceeded send limits (LIMIT NUMBER) for today"`<br>`}]`|Refer to [service limits](#daily-limits) for the limit number|
 |`500`|`[{`<br>`"error": "Exception",`<br>`"message": "Internal server error"`<br>`}]`|Notify was unable to process the request, resend your notification|
 
-## Send an email
+### Send an email
 
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -186,9 +186,9 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### templateId (required)
+##### templateId (required)
 
 To find the template ID:
 
@@ -202,7 +202,7 @@ For example:
 "f33517ff-2a88-4f6e-b855-c550268ce08a"
 ```
 
-#### emailAddress (required)
+##### emailAddress (required)
 
 The email address of the recipient. For example:
 
@@ -210,7 +210,7 @@ The email address of the recipient. For example:
 "sender@something.com"
 ```
 
-#### personalisation (required)
+##### personalisation (required)
 
 If a template has placeholder fields for personalised information such as name or application date, you must provide their values in an `object`. For example:
 
@@ -223,7 +223,7 @@ If a template has placeholder fields for personalised information such as name o
 }
 ```
 
-#### reference (required)
+##### reference (required)
 
 A unique identifier you create. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. If you do not have a reference, you must pass in an empty string or `null`. For example:
 
@@ -231,7 +231,7 @@ A unique identifier you create. This reference identifies a single unique notifi
 "your_reference_here"
 ```
 
-#### emailReplyToId (optional)
+##### emailReplyToId (optional)
 
 This is an email address specified by you to receive replies from your users. You must add at least one reply-to email address before your service can go live.
 
@@ -249,7 +249,7 @@ emailReplyToId='8e222534-7f05-4972-86e3-17c5d9f894e2'
 
 You can leave out this argument if your service only has one reply-to email address, or you want to use the default email address.
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -271,13 +271,13 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
 |err.response.data.status_code|err.response.data.errors|How to fix|
 |:--- |:---|:---|
-|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`]}`|Use the correct type of [API key](#api-keys)|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`}]`|Use the correct type of [API key](#api-keys)|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"`<br>`}]`|Your service cannot send this notification in [trial mode](https://www.notifications.service.gov.uk/features/using-notify#trial-mode)|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
@@ -285,20 +285,22 @@ If the request is not successful, the promise fails with an `err`.
 |`429`|`[{`<br>`"error": "TooManyRequestsError",`<br>`"message": "Exceeded send limits (LIMIT NUMBER) for today"`<br>`}]`|Refer to [service limits](#daily-limits) for the limit number|
 |`500`|`[{`<br>`"error": "Exception",`<br>`"message": "Internal server error"`<br>`}]`|Notify was unable to process the request, resend your notification|
 
-## Send a file by email
+### Send a file by email
 
 To send a file by email, add a placeholder to the template then upload a file. The placeholder will contain a secure link to download the file.
 
+The file will be available for the recipient to download for 18 months.
+
 The links are unique and unguessable. GOV.UK Notify cannot access or decrypt your file.
 
-### Add contact details to the file download page
+#### Add contact details to the file download page
 
 1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
 1. Go to the __Settings__ page.
 1. In the __Email__ section, select __Manage__ on the __Send files by email__ row.
 1. Enter the contact details you want to use, and select __Save__.
 
-### Add a placeholder to the template
+#### Add a placeholder to the template
 
 1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
 1. Go to the __Templates__ page and select the relevant email template.
@@ -307,9 +309,9 @@ The links are unique and unguessable. GOV.UK Notify cannot access or decrypt you
 
 "Download your file at: ((link_to_file))"
 
-### Upload your file
+#### Upload your file
 
-You can upload PDF, CSV, .odt, .txt and MS Word Document files. Your file must be smaller than 2MB. [Contact the GOV.UK Notify team](https://www.notifications.service.gov.uk/support/ask-question-give-feedback) if you need to send other file types.
+You can upload PDF, CSV, .odt, .txt, .rtf, .xlsx and MS Word Document files. Your file must be smaller than 2MB. [Contact the GOV.UK Notify team](https://www.notifications.service.gov.uk/support/ask-question-give-feedback) if you need to send other file types.
 
 Pass the file object as a value into the `personalisation` argument. For example:
 
@@ -333,7 +335,7 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-#### CSV Files
+##### CSV Files
 
 Uploads for CSV files should use the `isCsv` parameter on the `prepareUpload()` function.  For example:
 
@@ -352,7 +354,7 @@ fs.readFile('path/to/document.csv', function (err, csvFile) {
 })
 ```
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -374,15 +376,15 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
 |err.response.data.status_code|err.response.data.errors|How to fix|
 |:---|:---|:---|
-|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`]}`|Use the correct type of [API key](#api-keys)|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`}]`|Use the correct type of [API key](#api-keys)|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"`<br>`}]`|Your service cannot send this notification in [trial mode](https://www.notifications.service.gov.uk/features/using-notify#trial-mode)|
-|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Unsupported file type '(FILE TYPE)'. Supported types are: '(ALLOWED TYPES)'"`<br>`}]`|Wrong file type. You can only upload .pdf, .csv, .txt, .doc, .docx or .odt files|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Unsupported file type '(FILE TYPE)'. Supported types are: '(ALLOWED TYPES)'"`<br>`}]`|Wrong file type. You can only upload .pdf, .csv, .txt, .doc, .docx, .xlsx, .rtf or .odt files|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "File did not pass the virus scan"`<br>`}]`|The file contains a virus|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Send files by email has not been set up - add contact details for your service at https://www.notifications.service.gov.uk/services/(SERVICE ID)/service-settings/send-files-by-email"`<br>`}]`|See how to [add contact details to the file download page](#add-contact-details-to-the-file-download-page)|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
@@ -392,7 +394,7 @@ If the request is not successful, the promise fails with an `err`.
 |`500`|`[{`<br>`"error": "Exception",`<br>`"message": "Internal server error"`<br>`}]`|Notify was unable to process the request, resend your notification.|
 |`N/A`|`File is larger than 2MB`|The file is too big. Files must be smaller than 2MB|
 
-## Send a letter
+### Send a letter
 
 When you add a new service it will start in [trial mode](https://www.notifications.service.gov.uk/features/trial-mode). You can only send letters when your service is live.
 
@@ -402,7 +404,7 @@ To send Notify a request to go live:
 1. Go to the __Settings__ page.
 1. In the __Your service is in trial mode__ section, select __request to go live__.
 
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -419,9 +421,9 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### templateId (required)
+##### templateId (required)
 
 To find the template ID:
 
@@ -435,15 +437,15 @@ For example:
 "f33517ff-2a88-4f6e-b855-c550268ce08a"
 ```
 
-#### personalisation (required)
+##### personalisation (required)
 
 The personalisation argument always contains the following parameters for the letter recipient’s address:
 
 - `address_line_1`
 - `address_line_2`
-- `address_line_3` 
-- `address_line_4` 
-- `address_line_5` 
+- `address_line_3`
+- `address_line_4`
+- `address_line_5`
 - `address_line_6`
 - `address_line_7`
 
@@ -468,7 +470,7 @@ Any other placeholder fields included in the letter template also count as requi
 }
 ```
 
-#### reference (optional)
+##### reference (optional)
 
 A unique identifier you can create if required. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. For example:
 
@@ -476,7 +478,7 @@ A unique identifier you can create if required. This reference identifies a sing
 "your_reference_here"
 ```
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -498,13 +500,13 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
 |err.response.data.status_code|err.response.data.errors|How to fix|
 |:--- |:---|:---|
-|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Cannot send letters with a team api key"`<br>`]}`|Use the correct type of [API key](#api-keys).|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Cannot send letters with a team api key"`<br>`}]`|Use the correct type of [API key](#api-keys).|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Cannot send letters when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"`<br>`}]`|Your service cannot send this notification in [trial mode](https://www.notifications.service.gov.uk/features/using-notify#trial-mode).|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "personalisation address_line_1 is a required property"`<br>`}]`|Ensure that your template has a field for the first line of the address, refer to [personalisation](#send-a-letter-arguments-personalisation-required) for more information.|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "Must be a real UK postcode"`<br>`}]`|Ensure that the value for the last line of the address is a real UK postcode.|
@@ -516,9 +518,9 @@ If the request is not successful, the promise fails with an `err`.
 |`500`|`[{`<br>`"error": "Exception",`<br>`"message": "Internal server error"`<br>`}]`|Notify was unable to process the request, resend your notification.|
 
 
-## Send a precompiled letter
+### Send a precompiled letter
 
-### Method
+#### Method
 
 ```javascript
 var response = notifyClient.sendPrecompiledLetter(
@@ -528,9 +530,9 @@ var response = notifyClient.sendPrecompiledLetter(
 )
 ```
 
-### Arguments
+#### Arguments
 
-#### reference (required)
+##### reference (required)
 
 A unique identifier you create. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. For example:
 
@@ -538,9 +540,9 @@ A unique identifier you create. This reference identifies a single unique notifi
 "your_reference_here"
 ```
 
-#### pdfFile
+##### pdfFile
 
-The precompiled letter must be a PDF file which meets [the GOV.UK Notify PDF letter specification](https://docs.notifications.service.gov.uk/documentation/images/notify-pdf-letter-spec-v2.4.pdf). For example:
+The precompiled letter must be a PDF file which meets [the GOV.UK Notify letter specification](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification). For example:
 
 ```javascript
 var fs = require('fs')
@@ -555,12 +557,12 @@ fs.readFile('path/to/document.pdf', function (err, pdfFile) {
 })
 ```
 
-#### postage (optional)
+##### postage (optional)
 
 You can choose first or second class postage for your precompiled letter. Set the value to `first` for first class, or `second` for second class. If you do not pass in this argument, the postage will default to second class.
 
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -572,13 +574,13 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
 |err.response.data.status_code|err.response.data.errors|How to fix|
 |:--- |:---|:---|
-|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Cannot send letters with a team api key"`<br>`]}`|Use the correct type of [API key](#api-keys)|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Cannot send letters with a team api key"`<br>`}]`|Use the correct type of [API key](#api-keys)|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Cannot send letters when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"`<br>`}]`|Your service cannot send this notification in [trial mode](https://www.notifications.service.gov.uk/features/using-notify#trial-mode)|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "personalisation address_line_1 is a required property"`<br>`}]`|Send a valid PDF file|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "postage invalid. It must be either first or second."`<br>`}]`|Change the value of `postage` argument in the method call to either 'first' or 'second'|
@@ -590,51 +592,14 @@ If the request is not successful, the promise fails with an `err`.
 |N/A|`"message":"reference cannot be null or empty"`|Populate the reference parameter|
 |N/A|`"message":"precompiledPDF cannot be null or empty"`|Send a PDF file with data in it|
 
-# Get message status
-
-Message status depends on the type of message you have sent.
-
-You can only get the status of messages that are 7 days old or newer.
-
-## Status - email
-
-|Status|Information|
-|:---|:---|
-|Created|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
-|Sending|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
-|Delivered|The message was successfully delivered.|
-|Failed|This covers all failure statuses:<br>- `permanent-failure` - "The provider could not deliver the message because the email address was wrong. You should remove these email addresses from your database."<br>- `temporary-failure` - "The provider could not deliver the message. This can happen when the recipient’s inbox is full. You can try to send the message again."<br>- `technical-failure` - "Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again."|
-
-## Status - text message
-
-|Status|Information|
-|:---|:---|
-|Created|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
-|Sending|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
-|Pending|GOV.UK Notify is waiting for more delivery information.<br>GOV.UK Notify received a callback from the provider but the recipient’s device has not yet responded. Another callback from the provider determines the final status of the notification.|
-|Sent / Sent internationally|The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information. The GOV.UK Notify client API returns this status as `sent`. The GOV.UK Notify client app returns this status as `Sent internationally`.|
-|Delivered|The message was successfully delivered.|
-|Failed|This covers all failure statuses:<br>- `permanent-failure` - "The provider could not deliver the message. This can happen if the phone number was wrong or if the network operator rejects the message. If you’re sure that these phone numbers are correct, you should [contact GOV.UK Notify support](https://www.notifications.service.gov.uk/support). If not, you should remove them from your database. You’ll still be charged for text messages that cannot be delivered."<br>- `temporary-failure` - "The provider could not deliver the message. This can happen when the recipient’s phone is off, has no signal, or their text message inbox is full. You can try to send the message again. You’ll still be charged for text messages to phones that are not accepting messages."<br>- `technical-failure` - "Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure."|
+## Get message status
 
-## Status - letter
 
-|Status|information|
-|:---|:---|
-|Failed|The only failure status that applies to letters is `technical-failure`. GOV.UK Notify had an unexpected error while sending to our printing provider.|
-|Accepted|GOV.UK Notify has sent the letter to the provider to be printed.|
-|Received|The provider has printed and dispatched the letter.|
+### Get the status of one message
 
-## Status - precompiled letter
+You can only get the status of messages sent within the retention period. The default retention period is 7 days.
 
-|Status|information|
-|:---|:---|
-|Pending virus check|GOV.UK Notify has not completed a virus scan of the precompiled letter file.|
-|Virus scan failed|GOV.UK Notify found a potential virus in the precompiled letter file.|
-|Validation failed|Content in the precompiled letter file is outside the printable area. [See the GOV.UK Notify PDF letter specification](https://docs.notifications.service.gov.uk/documentation/images/notify-pdf-letter-spec-v2.3.pdf) for more information. |
-
-## Get the status of one message
-
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -648,15 +613,16 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### notificationId (required)
+##### notificationId (required)
 
-The ID of the notification. You can find the notification ID in the response to the original notification method call.
+The ID of the notification. To find the notification ID, you can either:
 
-You can also find it by [signing in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and going to the __API integration__ page.
+* check the response to the [original notification method call](#response)
+* [sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __API integration__ page
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -689,7 +655,7 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
@@ -701,13 +667,13 @@ If the request is not successful, the promise fails with an `err`.
 |`404`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No result found"`<br>`}]`|Check the notification ID|
 
 
-## Get the status of multiple messages
+### Get the status of multiple messages
 
-This API call returns one page of up to 250 messages and statuses. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the [`olderThanId`](#olderthanid) argument.
+This API call returns one page of up to 250 messages and statuses. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the [`olderThan`](#olderthan-optional) argument.
 
 You can only get the status of messages that are 7 days old or newer.
 
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -725,22 +691,22 @@ To get the most recent messages, you must pass in an empty `olderThan` argument
 
 To get older messages, pass the ID of an older notification into the `olderThan` argument. This returns the next oldest messages from the specified notification ID.
 
-### Arguments
+#### Arguments
 
 You can pass in empty arguments or `null` to ignore these filters.
 
-#### status (optional)
+##### status (optional)
 
 You can filter by each:
 
-* [email status](#status-email)
-* [text message status](#status-text-message)
-* [letter status](#status-letter)
-* [precompiled letter status](#status-precompiled-letter)
+* [email status](#email-status-descriptions)
+* [text message status](#text-message-status-descriptions)
+* [letter status](#letter-status-descriptions)
+* [precompiled letter status](#precompiled-letter-status-descriptions)
 
 You can leave out this argument to ignore this filter.
 
-#### notificationType (optional)
+##### notificationType (optional)
 
 You can filter by:
 
@@ -748,7 +714,7 @@ You can filter by:
 * `sms`
 * `letter`
 
-#### reference (optional)
+##### reference (optional)
 
 A unique identifier you create if necessary. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. For example:
 
@@ -756,7 +722,7 @@ A unique identifier you create if necessary. This reference identifies a single
 "your_reference_here"
 ```
 
-#### olderThan (optional)
+##### olderThan (optional)
 
 Input the ID of a notification into this argument. If you use this argument, the client returns the next 250 received notifications older than the given ID. For example:
 
@@ -766,7 +732,7 @@ Input the ID of a notification into this argument. If you use this argument, the
 
 If you pass in an empty argument or `null`, the client returns the most recent 250 notifications.
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -806,7 +772,7 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
@@ -817,10 +783,56 @@ If the request is not successful, the promise fails with an `err`.
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
 
+### Email status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`created`|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
+|#`sending`|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
+|#`delivered`|The message was successfully delivered.|
+|#`permanent-failure`|The provider could not deliver the message because the email address was wrong. You should remove these email addresses from your database.|
+|#`temporary-failure`|The provider could not deliver the message. This can happen when the recipient’s inbox is full or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you try to send the message again.|
+|#`technical-failure`|Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again.|
+
+### Text message status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`created`|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
+|#`sending`|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
+|#`pending`|GOV.UK Notify is waiting for more delivery information.<br>GOV.UK Notify received a callback from the provider but the recipient’s device has not yet responded. Another callback from the provider determines the final status of the text message.|
+|#`sent`|The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information. The GOV.UK Notify website displays this status as 'Sent to an international number'.|
+|#`delivered`|The message was successfully delivered.|
+|#`permanent-failure`|The provider could not deliver the message. This can happen if the phone number was wrong or if the network operator rejects the message. If you’re sure that these phone numbers are correct, you should [contact GOV.UK Notify support](https://www.notifications.service.gov.uk/support). If not, you should remove them from your database. You’ll still be charged for text messages that cannot be delivered.
+|#`temporary-failure`|The provider could not deliver the message. This can happen when the recipient’s phone is off, has no signal, or their text message inbox is full. You can try to send the message again. You’ll still be charged for text messages to phones that are not accepting messages.|
+|#`technical-failure`|Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure.|
+
+### Letter status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.|
+|#`received`|The provider has printed and dispatched the letter.|
+|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.|
+|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.|
+|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.|
+
+### Precompiled letter status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.|
+|#`received`|The provider has printed and dispatched the letter.|
+|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.|
+|#`pending-virus-check`|GOV.UK Notify has not completed a virus scan of the precompiled letter file.|
+|#`virus-scan-failed`|GOV.UK Notify found a potential virus in the precompiled letter file.|
+|#`validation-failed`|Content in the precompiled letter file is outside the printable area. See the [GOV.UK Notify letter specification](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.|
+|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.|
+|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.|
 
-## Get a PDF for a letter notification
+### Get a PDF for a letter notification
 
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -836,19 +848,20 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with `fileBuffer` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### notification_id (required)
+##### notificationId (required)
 
-The ID of the notification. You can find the notification ID in the response to the [original notification method call](/python.html#get-the-status-of-one-message-response).
+The ID of the notification. To find the notification ID, you can either:
 
-You can also find it by [signing in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and going to the __API integration__ page.
+* check the response to the [original notification method call](#get-the-status-of-one-message-response)
+* [sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __API integration__ page
 
-### Response
+#### Response
 
 If the request to the client is successful, the client will return an instance of the [Buffer](https://nodejs.org/api/buffer.html#buffer_buffer) class containing the raw PDF data.
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the client will return an `HTTPError` containing the relevant error code:
 
@@ -864,11 +877,11 @@ If the request is not successful, the client will return an `HTTPError` containi
 |`404`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No result found"`<br>`}]`|Check the notification ID|
 
 
-# Get a template
+## Get a template
 
-## Get a template by ID
+### Get a template by ID
 
-### Method
+#### Method
 
 This returns the latest version of the template.
 
@@ -884,9 +897,9 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### templateId (required)
+##### templateId (required)
 
 The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __Templates__ page to find it. For example:
 
@@ -894,7 +907,7 @@ The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.ser
 "f33517ff-2a88-4f6e-b855-c550268ce08a"
 ```
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -913,7 +926,7 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
@@ -921,12 +934,12 @@ If the request is not successful, the promise fails with an `err`.
 |:---|:---|:---|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
-|`404`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No Result Found"`<br>`}]`|Check your [template ID](#arguments-template-id-required)|
+|`404`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No Result Found"`<br>`}]`|Check your [template ID](#get-a-template-by-id-arguments-templateid-required)|
 
 
-## Get a template by ID and version
+### Get a template by ID and version
 
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -940,9 +953,9 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### templateId (required)
+##### templateId (required)
 
 The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __Templates__ page to find it. For example:
 
@@ -950,11 +963,11 @@ The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.ser
 "f33517ff-2a88-4f6e-b855-c550268ce08a"
 ```
 
-#### version (required)
+##### version (required)
 
 The version number of the template.
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -973,7 +986,7 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
@@ -982,12 +995,12 @@ If the request is not successful, the promise fails with an `err`.
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "id is not a valid UUID"`<br>`}]`|Check the notification ID|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
-|`404`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No Result Found"`<br>`}]`|Check your [template ID](#get-a-template-by-id-and-version-arguments-template-id-required) and [version](#version)|
+|`404`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No Result Found"`<br>`}]`|Check your [template ID](#get-a-template-by-id-and-version-arguments-templateid-required) and [version](#version-required)|
 
 
-## Get all templates
+### Get all templates
 
-### Method
+#### Method
 
 This returns the latest version of all templates.
 
@@ -1003,9 +1016,9 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 - resolve with a `response` if successful
 - fail with an `err` if unsuccessful
 
-### Arguments
+#### Arguments
 
-#### templateType (optional)
+##### templateType (optional)
 
 If you do not use `templateType`, the client returns all templates. Otherwise you can filter by:
 
@@ -1013,7 +1026,7 @@ If you do not use `templateType`, the client returns all templates. Otherwise yo
 - `sms`
 - `letter`
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -1041,9 +1054,9 @@ If the request is successful, the promise resolves with a `response` `object`. F
 
 If no templates exist for a template type or there no templates for a service, the object is empty.
 
-## Generate a preview template
+### Generate a preview template
 
-### Method
+#### Method
 
 This generates a preview version of a template.
 
@@ -1062,9 +1075,9 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 
 The parameters in the personalisation argument must match the placeholder fields in the actual template. The API notification client ignores any extra fields in the method.
 
-### Arguments
+#### Arguments
 
-#### templateId (required)
+##### templateId (required)
 
 The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __Templates__ page to find it. For example:
 
@@ -1072,7 +1085,7 @@ The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.ser
 "f33517ff-2a88-4f6e-b855-c550268ce08a"
 ```
 
-#### personalisation (optional)
+##### personalisation (optional)
 
 If a template has placeholder fields for personalised information such as name or application date, you must provide their values in an `object`. For example:
 
@@ -1087,7 +1100,7 @@ If a template has placeholder fields for personalised information such as name o
 
 You can leave out this argument if a template does not have any placeholder fields for personalised information.
 
-### Response
+#### Response
 
 If the request is successful, the promise resolves with a `response` `object`. For example, the `response.data` property will look like this:
 
@@ -1102,33 +1115,33 @@ If the request is successful, the promise resolves with a `response` `object`. F
 }
 ```
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 
 |err.response.data.status_code|err.response.data.errors|How to fix|
 |:---|:---|:---|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Missing personalisation: [PERSONALISATION FIELD]"`<br>`}]`|Check that the personalisation arguments in the method match the placeholder fields in the template|
-|`400`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No result found"`<br>`}]`|Check the [template ID](#generate-a-preview-template-required-arguments-template-id)|
+|`400`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No result found"`<br>`}]`|Check the [template ID](#generate-a-preview-template-arguments-templateid-required)|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
 
 
-# Get received text messages
+## Get received text messages
 
-This API call returns one page of up to 250 received text messages. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the [`olderThanId`](#olderThanId) argument.
+This API call returns one page of up to 250 received text messages. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the [`olderThan`](#get-a-page-of-received-text-messages-arguments-olderthan-optional) argument.
 
 You can only get messages that are 7 days old or newer.
 
 You can also set up [callbacks](#callbacks) for received text messages.
 
-## Enable received text messages
+### Enable received text messages
 
 Contact the GOV.UK Notify team using the [support page](https://www.notifications.service.gov.uk/support) or [chat to us on Slack](https://ukgovernmentdigital.slack.com/messages/C0E1ADVPC) to request a unique number for text message replies.
 
-## Get a page of received text messages
+### Get a page of received text messages
 
-### Method
+#### Method
 
 ```javascript
 notifyClient
@@ -1146,9 +1159,9 @@ To get the most recent messages, you must pass in an empty argument or `null`.
 
 To get older messages, pass the ID of an older notification into the `olderThan` argument. This returns the next oldest messages from the specified notification ID.
 
-### Arguments
+#### Arguments
 
-#### olderThan (optional)
+##### olderThan (optional)
 
 Input the ID of a received text message into this argument. If you use this argument, the client returns the next 250 received text messages older than the given ID. For example:
 
@@ -1158,7 +1171,7 @@ Input the ID of a received text message into this argument. If you use this argu
 
 If you pass in an empty argument or `null`, the client returns the most recent 250 text messages.
 
-### Response
+#### Response
 
 If the request to the client is successful, the promise resolves with an `object` containing all received texts.
 
@@ -1185,7 +1198,7 @@ If the request to the client is successful, the promise resolves with an `object
 
 If the notification specified in the `olderThan` argument is older than 7 days, the promise resolves an empty response.
 
-### Error codes
+#### Error codes
 
 If the request is not successful, the promise fails with an `err`.
 

package/Makefile

@@ -1,22 +1,16 @@
 .DEFAULT_GOAL := help
 SHELL := /bin/bash
 
-DOCKER_BUILDER_IMAGE_NAME = govuk/notify-nodejs-client-runner
-
-BUILD_TAG ?= notifications-nodejs-client-manual
-
-DOCKER_CONTAINER_PREFIX = ${USER}-${BUILD_TAG}
-
 .PHONY: help
 help:
 	@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-.PHONY: dependencies
-dependencies:  ## Install build dependencies
-	npm install
+.PHONY: bootstrap
+bootstrap:  ## Install build dependencies
+	npm ci
 
 .PHONY: build
-build: dependencies ## Build project
+build: bootstrap ## Build project (dummy task for CI)
 
 .PHONY: test
 test: ## Run tests
@@ -26,70 +20,22 @@ test: ## Run tests
 integration-test: ## Run integration tests
 	npm test --integration
 
-.PHONY: markdown-standard-test
-markdown-standard-test: ## Run linting on JavaScript examples in markdown using StandardJS
-	npm run test:markdown:standard
-
-.PHONY: markdown-standard-test-fix
-markdown-standard-test-fix: ## Fix errors found from linting
-	npm run test:markdown:standard -- --fix
-
-.PHONY: generate-env-file
-generate-env-file: ## Generate the environment file for running the tests inside a Docker container
-	script/generate_docker_env.sh
-
-.PHONY: prepare-docker-runner-image
-prepare-docker-runner-image: ## Prepare the Docker builder image
-	make -C docker build
-
-.PHONY: build-with-docker
-build-with-docker: prepare-docker-runner-image ## Build inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-build" \
-		-v "`pwd`:/var/project" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make build
+.PHONY: bootstrap-with-docker
+bootstrap-with-docker: ## Prepare the Docker builder image
+	docker build -t notifications-node-client .
+	./scripts/run_with_docker.sh make bootstrap
 
 .PHONY: test-with-docker
-test-with-docker: prepare-docker-runner-image generate-env-file ## Run tests inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-test" \
-		-v "`pwd`:/var/project" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
-		--env-file docker.env \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make test
+test-with-docker: ## Run tests inside a Docker container
+	./scripts/run_with_docker.sh make test
 
 .PHONY: integration-test-with-docker
-integration-test-with-docker: prepare-docker-runner-image generate-env-file ## Run integration tests inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-integration-test" \
-		-v "`pwd`:/var/project" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
-		--env-file docker.env \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make integration-test
+integration-test-with-docker: ## Run integration tests inside a Docker container
+	./scripts/run_with_docker.sh make integration-test
 
 .PHONY: get-client-version
 get-client-version: ## Retrieve client version number from source code
 	@node -p "require('./package.json').version"
 
-.PHONY: clean-docker-containers
-clean-docker-containers: ## Clean up any remaining docker containers
-	docker rm -f $(shell docker ps -q -f "name=${DOCKER_CONTAINER_PREFIX}") 2> /dev/null || true
-
 clean:
 	rm -rf .cache venv

package/client/api_client.js

@@ -1,7 +1,7 @@
 var restClient = require('axios').default,
     _ = require('underscore'),
     createGovukNotifyToken = require('../client/authentication.js'),
-    notifyProductionAPI = 'https://api.notifications.service.gov.uk'
+    notifyProductionAPI = 'https://api.notifications.service.gov.uk',
     version = require('../package.json').version;
 
 /**

package/client/notification.js

@@ -336,10 +336,10 @@ _.extend(NotifyClient.prototype, {
 
   /**
    *
-   * @param {String} url
+   * @param {object} an axios proxy config
    */
-  setProxy: function(url) {
-    this.apiClient.setProxy(url);
+  setProxy: function(proxyConfig) {
+    this.apiClient.setProxy(proxyConfig);
   },
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "5.0.0",
+  "version": "5.1.1",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -16,8 +16,8 @@
   "author": "GDS developers",
   "license": "MIT",
   "dependencies": {
-    "jsonwebtoken": "8.2.1",
-    "axios": "0.19.2",
+    "jsonwebtoken": "^8.2.1",
+    "axios": "^0.25.0",
     "underscore": "^1.9.0"
   },
   "devDependencies": {

package/scripts/run_with_docker.sh

@@ -0,0 +1,21 @@
+DOCKER_IMAGE_NAME=notifications-node-client
+
+source environment.sh
+
+docker run \
+  --rm \
+  -v "`pwd`:/var/project" \
+  -e NOTIFY_API_URL=${NOTIFY_API_URL} \
+  -e API_KEY=${API_KEY} \
+  -e FUNCTIONAL_TEST_NUMBER=${FUNCTIONAL_TEST_NUMBER} \
+  -e FUNCTIONAL_TEST_EMAIL=${FUNCTIONAL_TEST_EMAIL} \
+  -e EMAIL_TEMPLATE_ID=${EMAIL_TEMPLATE_ID} \
+  -e SMS_TEMPLATE_ID=${SMS_TEMPLATE_ID} \
+  -e LETTER_TEMPLATE_ID=${LETTER_TEMPLATE_ID} \
+  -e EMAIL_REPLY_TO_ID=${EMAIL_REPLY_TO_ID} \
+  -e SMS_SENDER_ID=${SMS_SENDER_ID} \
+  -e API_SENDING_KEY=${API_SENDING_KEY} \
+  -e INBOUND_SMS_QUERY_KEY=${INBOUND_SMS_QUERY_KEY} \
+  -it \
+  ${DOCKER_IMAGE_NAME} \
+  ${@}

package/.npmignore

@@ -1,6 +0,0 @@
-node_modules
-.idea/
-environment.sh
-package-lock.json
-.eslintrc.js
-docker.env

package/script/generate_docker_env.sh

@@ -1,28 +0,0 @@
-#!/usr/bin/env bash
-
-set -eo pipefail
-
-function exit_with_msg {
-    echo $1
-    exit $2
-}
-
-echo -n "" > docker.env
-
-env_vars=(
-    NOTIFY_API_URL
-    API_KEY
-    FUNCTIONAL_TEST_EMAIL
-    FUNCTIONAL_TEST_NUMBER
-    EMAIL_TEMPLATE_ID
-    LETTER_TEMPLATE_ID
-    SMS_TEMPLATE_ID
-    EMAIL_REPLY_TO_ID
-    SMS_SENDER_ID
-    API_SENDING_KEY
-    INBOUND_SMS_QUERY_KEY
-)
-
-for env_var in "${env_vars[@]}"; do
-    echo "${env_var}=${!env_var}" >> docker.env
-done