feat: Add contextMessageUuid to WhatsappRequest

Author: SMadani

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 # [8.7.0] - 2024-05-??
 - Added missing supported languages to `TextToSpeechLanguage` enum
 - Added `ttl` field to outbound MMS messages
-- 
+- Added message reply context to Whatsapp outbound requests
 
 # [8.6.0] - 2024-04-18
 - Added Experience Composer to Video API

src/main/java/com/vonage/client/messages/whatsapp/Context.java

@@ -32,6 +32,10 @@ public final class Context extends JsonableBaseObject {
 
 	Context() {}
 
+	Context(UUID messageUuid) {
+		this.messageUuid = messageUuid;
+	}
+
 	/**
 	 * The phone number of the original sender of the message being quoted.
 	 *

src/main/java/com/vonage/client/messages/whatsapp/WhatsappRequest.java

@@ -15,15 +15,19 @@
  */
 package com.vonage.client.messages.whatsapp;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.vonage.client.common.E164;
 import com.vonage.client.messages.Channel;
 import com.vonage.client.messages.MessageRequest;
 import com.vonage.client.messages.MessageType;
-import com.vonage.client.common.E164;
+import java.util.UUID;
 
 public abstract class WhatsappRequest extends MessageRequest {
+	final Context context;
 
 	protected WhatsappRequest(Builder<?, ?> builder, MessageType messageType) {
 		super(builder, Channel.WHATSAPP, messageType);
+        context = builder.messageUuid != null ? new Context(builder.messageUuid) : null;
 	}
 
 	@Override
@@ -32,6 +36,29 @@ protected void validateSenderAndRecipient(String from, String to) throws Illegal
 		this.to = new E164(to).toString();
 	}
 
+	@JsonProperty("context")
+	public Context getContext() {
+		return context;
+	}
+
+	@SuppressWarnings("unchecked")
 	protected abstract static class Builder<M extends WhatsappRequest, B extends Builder<? extends M, ? extends B>> extends MessageRequest.Builder<M, B> {
+		UUID messageUuid;
+
+		/**
+		 * An optional context used for quoting/replying to a specific message in a conversation. When used,
+		 * the WhatsApp UI will display the new message along with a contextual bubble that displays the
+		 * quoted/replied to message's content.<br>
+		 * This field is the UUID of the message being replied to or quoted.
+		 *
+		 * @param messageUuid The context's message UUID as a string.
+		 *
+		 * @return This builder.
+		 * @since 8.7.0
+		 */
+		public B contextMessageId(String messageUuid) {
+			this.messageUuid = UUID.fromString(messageUuid);
+			return (B) this;
+		}
 	}
 }

src/test/java/com/vonage/client/messages/whatsapp/WhatsappFileRequestTest.java

@@ -17,28 +17,31 @@
 
 import org.junit.jupiter.api.Test;
 import static org.junit.jupiter.api.Assertions.*;
+import java.util.UUID;
 
 public class WhatsappFileRequestTest {
+	String from = "447900000001", to = "317900000002";
 
 	@Test
 	public void testSerializeValid() {
+		String messageUuid = UUID.randomUUID().toString();
 		String url = "file:///path/to/attachment.zip", caption = "Srs bzns", name = "Stuff";
 		String json = WhatsappFileRequest.builder()
-				.from("317900000002").to("447900000001")
-				.url(url).caption(caption).name(name)
-				.build().toJson();
+				.from(from).to(to).url(url).contextMessageId(messageUuid)
+				.caption(caption).name(name).build().toJson();
+
 		assertTrue(json.contains(
-				"\"file\":{\"url\":\""+url+ "\",\"caption\":\""+caption+"\",\"name\":\""+name+"\"}"
+				"\"file\":{\"url\":\""+url+"\",\"caption\":\"" + caption + "\",\"name\":\""+name+"\"}"
 		));
+		assertTrue(json.contains("\"context\":{\"message_uuid\":\""+messageUuid+"\"}"));
 		assertTrue(json.contains("\"message_type\":\"file\""));
 		assertTrue(json.contains("\"channel\":\"whatsapp\""));
 	}
 
 	@Test
 	public void testSerializeNoCaptionOrName() {
 		String url = "file:///path/to/spec.pdf";
-		WhatsappFileRequest req = WhatsappFileRequest.builder()
-				.url(url).from("447900000002").to("447900000001").build();
+		WhatsappFileRequest req = WhatsappFileRequest.builder().url(url).from(from).to(to).build();
 		assertNull(req.getFile().getName());
 		String json = req.toJson();
 		assertTrue(json.contains("\"file\":{\"url\":\""+url+"\"}"));
@@ -49,7 +52,7 @@ public void testSerializeNoCaptionOrName() {
 	@Test
 	public void testConstructNoUrl() {
 		assertThrows(NullPointerException.class, () -> WhatsappFileRequest.builder()
-				.caption("Description").from("447900000001").to("317900000002").build()
+				.caption("Description").from(from).to(to).build()
 		);
 	}
 }

src/test/java/com/vonage/client/messages/whatsapp/WhatsappImageRequestTest.java

@@ -30,6 +30,7 @@ public void testSerializeValid() {
 		assertTrue(json.contains("\"image\":{\"url\":\""+url+"\",\"caption\":\""+caption+"\"}"));
 		assertTrue(json.contains("\"message_type\":\"image\""));
 		assertTrue(json.contains("\"channel\":\"whatsapp\""));
+		assertFalse(json.contains("\"context\""));
 	}
 
 	@Test

src/test/java/com/vonage/client/messages/whatsapp/WhatsappTextRequestTest.java

@@ -15,64 +15,63 @@
  */
 package com.vonage.client.messages.whatsapp;
 
-import org.junit.jupiter.api.Test;
-
 import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.*;
+import java.util.UUID;
 
 public class WhatsappTextRequestTest {
+	String from = "447900000001", to = "317900000002", txt = "Hello, World!";
 
 	@Test
 	public void testSerializeValid() {
-		String from = "447900000001", to = "317900000002", txt = "Hello, World!";
-		String json = WhatsappTextRequest.builder().from(from).to(to).text(txt).build().toJson();
+		String messageUuid = UUID.randomUUID().toString();
+		String json = WhatsappTextRequest.builder().from(from).to(to).text(txt)
+				.contextMessageId(messageUuid).build().toJson();
+
 		assertTrue(json.contains("\"text\":\""+txt+"\""));
 		assertTrue(json.contains("\"from\":\""+from+"\""));
 		assertTrue(json.contains("\"to\":\""+to+"\""));
+		assertTrue(json.contains("\"context\":{\"message_uuid\":\""+messageUuid+"\"}"));
 		assertTrue(json.contains("\"message_type\":\"text\""));
 		assertTrue(json.contains("\"channel\":\"whatsapp\""));
 	}
 
 	@Test
 	public void testConstructEmptySender() {
 		assertThrows(IllegalArgumentException.class, () -> WhatsappTextRequest.builder()
-				.from("").to("317900000002").text("Hello, World!").build()
+				.from("").to(to).text(txt).build()
 		);
 	}
 
 	@Test
 	public void testConstructNoSender() {
 		assertThrows(NullPointerException.class, () -> WhatsappTextRequest.builder()
-				.to("317900000002").text("Hello, World!").build()
+				.to(to).text(txt).build()
 		);
 	}
 
 	@Test
 	public void testConstructNullText() {
 		assertThrows(NullPointerException.class, () -> WhatsappTextRequest.builder()
-				.from("447900000001").to("317900000002").build()
+				.from(from).to(to).build()
 		);
 	}
 
 	@Test
 	public void testConstructEmptyText() {
 		assertThrows(IllegalArgumentException.class, () -> WhatsappTextRequest.builder()
-				.from("447900000001").to("317900000002").text("").build()
+				.from(from).to(to).text("").build()
 		);
 	}
 
 	@Test
 	public void testConstructLongText() {
 		StringBuilder text = new StringBuilder(1002);
-		for (int i = 0; i < 4095; i++) {
-			text.append('*');
-		}
+        text.append("*".repeat(4095));
 		assertEquals(4095, text.length());
 
 		WhatsappTextRequest msg = WhatsappTextRequest.builder()
-				.text(text.toString())
-				.from("447900000001")
-				.to("317900000002")
-				.build();
+				.text(text.toString()).from(from).to(to).build();
 
 		assertEquals(text.toString(), msg.getText());
 		text.append("xy");