<?xml version='1.0' encoding='UTF-8'?>
<settings xsi:schemaLocation='http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd' xmlns='http://maven.apache.org/SETTINGS/1.0.0' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
<profiles>
	<profile>
		<repositories>
			<repository>
				<snapshots>
					<enabled>false</enabled>
				</snapshots>
				<id>bintray-gov-uk-notify-maven</id>
				<name>bintray</name>
				<url>http://dl.bintray.com/gov-uk-notify/maven</url>
			</repository>
		</repositories>
		<pluginRepositories>
			<pluginRepository>
				<snapshots>
					<enabled>false</enabled>
				</snapshots>
				<id>bintray-gov-uk-notify-maven</id>
				<name>bintray-plugins</name>
				<url>http://dl.bintray.com/gov-uk-notify/maven</url>
			</pluginRepository>
		</pluginRepositories>
		<id>bintray</id>
	</profile>
</profiles>
<activeProfiles>
	<activeProfile>bintray</activeProfile>
</activeProfiles>
</settings>

Then add the Maven dependency to your project.

    <dependency>
        <groupId>uk.gov.service.notify</groupId>
        <artifactId>notifications-java-client</artifactId>
        <version>3.8.0-RELEASE</version>
    </dependency>

    UUID notificationId;
    Optional<String> reference;
    UUID templateId;
    int templateVersion;
    String templateUri;
    String body;
    Optional<String> fromNumber;

Otherwise the client will raise a NotificationClientException:

The mobile number the SMS notification is sent to.

The template id is visible on the template page in the application.

An optional unique identifier for the notification or an identifier for a batch of notifications. reference can be an empty string or null.

If a template has placeholders, you need to provide their values, for example:

Map<String, String> personalisation = new HashMap<>();
personalisation.put("name", "Jo");
personalisation.put("reference_number", "13566");

Optional. Specifies the identifier of the text message sender to set for the notification. The identifiers are found in your service Settings, when you 'Manage' your 'Text message senders'. If you omit this argument your default text message sender will be for the notification.

	UUID notificationId;
	Optional<String> reference;
	UUID templateId;
	int templateVersion;
	String templateUri;
	String body;
	String subject;
	Optional<String> fromEmail;

Otherwise the client will raise a NotificationClientException:

The email address the email notification is sent to.

The template id is visible on the template page in the application.

If a template has placeholders, you need to provide their values, for example:

Map<String, String> personalisation = new HashMap<>();
personalisation.put("name", "Jo");
personalisation.put("reference_number", "13566");

An optional identifier you generate. The reference can be used as a unique reference for the notification. Because Notify does not require this reference to be unique you could also use this reference to identify a batch or group of notifications.

You can omit this argument if you do not require a reference for the notification.

Optional. Specifies the identifier of the email reply-to address to set for the notification. The identifiers are found in your service Settings, when you 'Manage' your 'Email reply to addresses'. If you omit this argument your default email reply-to address will be set for the notification.

	UUID notificationId;
	Optional<String> reference;
	UUID templateId;
	int templateVersion;
	String templateUri;
	String body;
	String subject;

Otherwise the client will raise a NotificationClientException:

The template id is visible on the template page in the application.

The letter must contain:

• mandatory address fields
• optional address fields if applicable
• fields from template

If you are sending a letter, you will need to provide the address fields in the format "address_line_#", numbered from 1 to 6, and also the "postcode" field The fields "address_line_1", "address_line_2" and "postcode" are required.

An optional unique identifier for the notification or an identifier for a batch of notifications. reference can be an empty string or null.

    UUID id;
    Optional<String> reference;
    Optional<String> emailAddress;
    Optional<String> phoneNumber;
    Optional<String> line1;
    Optional<String> line2;
    Optional<String> line3;
    Optional<String> line4;
    Optional<String> line5;
    Optional<String> line6;
    Optional<String> postcode;
    String notificationType;
    String status;
    UUID templateId;
    int templateVersion;
    String templateUri;
    String body;
    Optional<String subject;
    DateTime createdAt;
    Optional<DateTime> sentAt;
		Optional<DateTime> completedAt;
    Optional<DateTime> estimatedDelivery;

Otherwise the client will raise a NotificationClientException.

    List<Notification> notifications;
    String currentPageLink;
    Optional<String> nextPageLink;

Otherwise the client will raise a NotificationClientException.

email

You can filter by:

• created - the message is queued to be sent to the provider. The notification typically only remains in this state for a few seconds.
• sending - the message has been passed on to our providers to send to the recipient, and we are waiting for delivery information.
• delivered - the message was successfully delivered.
• failed - this will return all failure statuses permanent-failure, temporary-failure and technical-failure.
• permanent-failure - the provider was unable to deliver message, email does not exist; remove this recipient from your list.
• temporary-failure - the provider was unable to deliver message, email box was full; you can try to send the message again.
• technical-failure - Notify had a technical failure; you can try to send the message again.

You can omit this argument to ignore this filter.

text message

You can filter by:

• created - the message is queued to be sent to our providers. The notification typically only remains in this state for a few seconds.
• sending - the message has been passed on to our providers to send to the recipient, and we are waiting for delivery information.
• delivered - the message was successfully delivered.
• sent - the message was delivered internationally - we may not receive additional status updates depending on the recipient's country and telecoms provider.
• failed - this will return all failure statuses permanent-failure, temporary-failure and technical-failure.
• permanent-failure - the provider was unable to deliver message, phone number does not exist; remove this recipient from your list.
• temporary-failure - the provider was unable to deliver message, the phone was turned off; you can try to send the message again.
• technical-failure - Notify had a technical failure; you can try to send the message again.

You can omit this argument to ignore this filter.

letter

You can filter by:

• accepted - Notify is in the process of printing and posting the letter
• technical-failure - Notify had an unexpected error while sending to our printing provider

You can omit this argument to ignore this filter.

This is the reference you gave at the time of sending the notification. The reference can be a unique identifier for the notification or an identifier for a batch of notifications.

You can get the notifications older than a given Notification.notificationId.

• sms
• email
• letter

    UUID id;
    String templateType;
    DateTime createdAt;
    Optional<DateTime> updatedAt;
    String createdBy;
    int version;
    String body;
    Optional<String> subject;
    Optional<Map<String, Object>> personalisation;

Otherwise the client will raise a NotificationClientException.

The template id is visible on the template page in the application.

    UUID id;
    String templateType;
    DateTime createdAt;
    Optional<DateTime> updatedAt;
    String createdBy;
    int version;
    String body;
    Optional<String> subject;
    Optional<Map<String, Object>> personalisation;

Otherwise the client will raise a NotificationClientException:

The template id is visible on the template page in the application.

A history of the template is kept. There is a link to See previous versions on the template page in the application.

TemplateList templates = client.getAllTemplates(templateType);

See available template types

    List<Template> templates;

If the response is successful, a TemplateList is returned.

If no templates exist for a template type or there no templates for a service, the templates list will be empty.

You can filter the templates by the following options:

• email
• sms
• letter

You can also pass in an empty string or null to ignore the filter.

    UUID id;
    String templateType;
    int version;
    String body;
    Optional<String> subject;

Otherwise the client will raise a NotificationClientException:

The template id is visible on the template page in the application.

If a template has placeholders, you need to provide their values. personalisation can be an empty or null in which case no placeholders are provided for the notification.

Map<String, String> personalisation = new HashMap<>();
personalisation.put("name", "Jo");
personalisation.put("reference_number", "13566");

If the request is successful, response will be a ReceivedTextMessageList:

private List<ReceivedTextMessage> receivedTextMessages;
private String currentPageLink;
private String nextPageLink;

A ReceivedTextMessage will have the following properties -

private UUID id;
private String notifyNumber;
private String userNumber;
private UUID serviceId;
private String content;
private DateTime createdAt;

A String parameter, if null or empty 250 of the most recent messages are returned. Otherwise you can filter to fetch the latest 250 received text messages older than the given id.