feat: Q3 2024 Messages API updates

Author: SMadani

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0-RC2] - 2024-09-2?
+Messages API updates based on Java SDK v8.11.0
+
+### Added
+- RCS message type builders
+- WhatsApp Reaction builder
+- Ability to read and revoke messages (support for the `PATCH` endpoint in Messages API)
+
 ## [1.0.0-RC1] - 2024-09-12
 First release candidate
 

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>com.vonage</groupId>
   <artifactId>server-sdk-kotlin</artifactId>
-  <version>1.0.0-RC1</version>
+  <version>1.0.0-RC2</version>
 
   <name>Vonage Kotlin Server SDK</name>
   <description>Kotlin client for Vonage APIs</description>
@@ -55,7 +55,7 @@
     <dependency>
       <groupId>com.vonage</groupId>
       <artifactId>server-sdk</artifactId>
-      <version>8.10.0</version>
+      <version>8.11.0</version>
     </dependency>
     <dependency>
       <groupId>org.jetbrains.kotlin</groupId>
@@ -228,7 +228,7 @@
         <plugins>
           <plugin>
             <artifactId>maven-gpg-plugin</artifactId>
-            <version>3.2.5</version>
+            <version>3.2.6</version>
             <executions>
               <execution>
                 <id>sign-artifacts</id>

src/main/kotlin/com/vonage/client/kt/Messages.kt

@@ -15,12 +15,14 @@
  */
 package com.vonage.client.kt
 
+import com.vonage.client.ApiRegion
 import com.vonage.client.messages.*
 import com.vonage.client.messages.sms.*
 import com.vonage.client.messages.mms.*
 import com.vonage.client.messages.whatsapp.*
 import com.vonage.client.messages.messenger.*
 import com.vonage.client.messages.viber.*
+import com.vonage.client.messages.rcs.*
 import java.util.UUID
 
 /**
@@ -54,6 +56,51 @@ class Messages internal constructor(private val client: MessagesClient) {
     fun send(message: MessageRequest, sandbox: Boolean = false): UUID =
         (if (sandbox) client.useSandboxEndpoint()
             else client.useRegularEndpoint()).sendMessage(message).messageUuid
+
+    /**
+     * Call this method to update an existing message.
+     *
+     * @param id The message UUID as a string.
+     * @param region The API region server URL in which the message was sent.
+     *
+     * @return An [ExistingMessage] object for updating the existing message.
+     */
+    fun existingMessage(id: String, region: ApiRegion): ExistingMessage = ExistingMessage(id, region)
+
+    /**
+     * Class for working with an existing message.
+     *
+     * @property id The message ID.
+     * @property region The regional URL server in which the message was sent.
+     */
+    inner class ExistingMessage internal constructor(id: String, val region: ApiRegion): ExistingResource(id) {
+
+        /**
+         * Marks the inbound message as read. Currently only applies to the WhatsApp channel.
+         *
+         * @throws [MessageResponseException] If the message could not be updated.
+         * This may be for the following reasons:
+         * - **401**: Invalid credentials.
+         * - **404**: Not Found. The message ID is not known, or the wrong region was used.
+         * - **422**: Malformed request.
+         * - **429**: Too many requests.
+         * - **500**: Internal server error.
+         */
+        fun markAsRead(): Unit = client.ackInboundMessage(id, region)
+
+        /**
+         * Revokes the outbound message. Currently only applies to the RCS channel.
+         *
+         * @throws [MessageResponseException] If the message could not be updated.
+         * This may be for the following reasons:
+         * - **401**: Invalid credentials.
+         * - **404**: Not Found. The message ID is not known, or the wrong region was used.
+         * - **422**: Malformed request.
+         * - **429**: Too many requests.
+         * - **500**: Internal server error.
+         */
+        fun revoke(): Unit = client.revokeOutboundMessage(id, region)
+    }
 }
 
 /**
@@ -166,6 +213,16 @@ fun whatsappFile(properties: WhatsappFileRequest.Builder.() -> Unit): WhatsappFi
 fun whatsappSticker(properties: WhatsappStickerRequest.Builder.() -> Unit): WhatsappStickerRequest =
     WhatsappStickerRequest.builder().apply(properties).build()
 
+/**
+ * Creates a WhatsApp reaction message.
+ *
+ * @param properties A lambda function for setting the message's parameters.
+ *
+ * @return A [WhatsappReactionRequest] object with the specified properties.
+ */
+fun whatsappReaction(properties: WhatsappReactionRequest.Builder.() -> Unit): WhatsappReactionRequest =
+    WhatsappReactionRequest.builder().apply(properties).build()
+
 /**
  * Creates a WhatsApp location message.
  *
@@ -305,3 +362,53 @@ fun viberVideo(properties: ViberVideoRequest.Builder.() -> Unit): ViberVideoRequ
  */
 fun viberFile(properties: ViberFileRequest.Builder.() -> Unit): ViberFileRequest =
     ViberFileRequest.builder().apply(properties).build()
+
+/**
+ * Creates an RCS text message.
+ *
+ * @param properties A lambda function for setting the message's parameters.
+ *
+ * @return An [RcsTextRequest] object with the specified properties.
+ */
+fun rcsText(properties: RcsTextRequest.Builder.() -> Unit): RcsTextRequest =
+    RcsTextRequest.builder().apply(properties).build()
+
+/**
+ * Creates an RCS image message.
+ *
+ * @param properties A lambda function for setting the message's parameters.
+ *
+ * @return An [RcsImageRequest] object with the specified properties.
+ */
+fun rcsImage(properties: RcsImageRequest.Builder.() -> Unit): RcsImageRequest =
+    RcsImageRequest.builder().apply(properties).build()
+
+/**
+ * Creates an RCS video message.
+ *
+ * @param properties A lambda function for setting the message's parameters.
+ *
+ * @return An [RcsVideoRequest] object with the specified properties.
+ */
+fun rcsVideo(properties: RcsVideoRequest.Builder.() -> Unit): RcsVideoRequest =
+    RcsVideoRequest.builder().apply(properties).build()
+
+/**
+ * Creates an RCS file message.
+ *
+ * @param properties A lambda function for setting the message's parameters.
+ *
+ * @return An [RcsFileRequest] object with the specified properties.
+ */
+fun rcsFile(properties: RcsFileRequest.Builder.() -> Unit): RcsFileRequest =
+    RcsFileRequest.builder().apply(properties).build()
+
+/**
+ * Creates an RCS custom message.
+ *
+ * @param properties A lambda function for setting the message's parameters.
+ *
+ * @return An [RcsCustomRequest] object with the specified properties.
+ */
+fun rcsCustom(properties: RcsCustomRequest.Builder.() -> Unit): RcsCustomRequest =
+    RcsCustomRequest.builder().apply(properties).build()

src/test/kotlin/com/vonage/client/kt/AbstractTest.kt

@@ -101,13 +101,15 @@ abstract class AbstractTest {
     protected val fileUrl = "$exampleUrlBase/file.pdf"
 
     private val port = 8081
+    private val wmBaseUrl = "http://localhost:$port"
     private val wiremock: WireMockServer = WireMockServer(
         options().port(port).notifier(ConsoleNotifier(false))
     )
 
     val vonage = Vonage {
         authFromEnv(); httpConfig {
-            baseUri("http://localhost:$port")
+            baseUri(wmBaseUrl)
+            regionalUriGetter { wmBaseUrl }
         }
         apiKey(apiKey); apiSecret(apiSecret); signatureSecret(null)
         applicationId(applicationId); privateKeyPath(privateKeyPath)