chore: Publish v5.3.2+ads-SNAPSHOT

Author: dtayeh

code/README.md

@@ -5,7 +5,7 @@
 <dependency>
     <groupId>com.expediagroup</groupId>
     <artifactId>rapid-sdk</artifactId>
-    <version>5.3.2</version>
+    <version>5.3.2+ads-SNAPSHOT</version>
 </dependency>
 ```
 

code/pom.xml

@@ -4,9 +4,9 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.expediagroup</groupId>
     <artifactId>rapid-sdk</artifactId>
-    <version>5.3.2</version>
+    <version>5.3.2+ads-SNAPSHOT</version>
     <name>EG rapid-sdk for Java</name>
-    <description>EG rapid-sdk v5.3.2</description>
+    <description>EG rapid-sdk v5.3.2+ads-SNAPSHOT</description>
     <url>https://github.com/ExpediaGroup/test-sdk</url>
     <inceptionYear>2022</inceptionYear>
     <packaging>jar</packaging>
@@ -79,7 +79,7 @@
         <properties.maven.plugin.version>1.2.1</properties.maven.plugin.version>
         <maven.licence.plugin.version>4.6</maven.licence.plugin.version>
         <flatten.maven.plugin.version>1.6.0</flatten.maven.plugin.version>
-        <kotlin.version>2.1.0</kotlin.version>
+        <kotlin.version>2.1.10</kotlin.version>
         <kotlinx.coroutines.version>1.10.1</kotlinx.coroutines.version>
         <ktor.version>3.0.3</ktor.version>
         <kotlin-atomic.version>0.27.0</kotlin-atomic.version>

code/src/main/kotlin/com/expediagroup/sdk/core/constant/provider/LogMaskingRegexProvider.kt

@@ -16,19 +16,38 @@
 package com.expediagroup.sdk.core.constant.provider
 
 internal object LogMaskingRegexProvider {
+    /**
+     * Generates a regex pattern to match specified fields in a JSON string.
+     *
+     * @param maskedBodyFields the set of fields to be masked
+     * @param valueToMatch regex pattern to match the value of the fields. Default: match any sequence of characters except double quotes.
+     * @return the regex pattern to match the specified fields and their values
+     */
     fun getMaskedFieldsRegex(
         maskedBodyFields: Set<String>,
-        value: String = "[^\\\"]+"
+        valueToMatch: String = "[^\\\"]+"
     ): Regex {
         val fields = maskedBodyFields.joinToString("|")
-        return "\"($fields)(\\\\*\"\\s*:\\s*\\\\*\")$value(?:\\\\?\"|)".toRegex()
+        // The pattern matches:
+        // - The field name (one of the specified fields) captured in group 1.
+        // - Optional backslash, closing double quotes, colon(:), optional whitespace, and opening double quotes.
+        // - The value of the field, matching the specified valueToMatch pattern.
+        // - Optional backslash, followed by a closing double quote
+        return "\"($fields)(\\\\?\"\\s*:\\s*\\\\*\")$valueToMatch(?:\\\\?\")".toRegex()
     }
 
+    /**
+     * Generates a regex pattern to match a specified field in a JSON string.
+     *
+     * @param maskedBodyField the field to be masked
+     * @param valueToMatch regex pattern to match the value of the field. Default: match any sequence of characters except double quotes.
+     * @return the regex pattern to match the specified field and its value
+     */
     fun getMaskedFieldsRegex(
         maskedBodyField: String,
-        value: String = "[^\\\"]+"
+        valueToMatch: String = "[^\\\"]+"
     ): Regex {
         val fields = setOf(maskedBodyField)
-        return getMaskedFieldsRegex(fields, value)
+        return getMaskedFieldsRegex(fields, valueToMatch)
     }
 }

code/src/main/kotlin/com/expediagroup/sdk/rapid/client/RapidClient.kt

@@ -42,6 +42,8 @@ import com.expediagroup.sdk.rapid.operations.DeleteRoomOperation
 import com.expediagroup.sdk.rapid.operations.DeleteRoomOperationParams
 import com.expediagroup.sdk.rapid.operations.GetAdditionalAvailabilityOperation
 import com.expediagroup.sdk.rapid.operations.GetAdditionalAvailabilityOperationParams
+import com.expediagroup.sdk.rapid.operations.GetAdsOperation
+import com.expediagroup.sdk.rapid.operations.GetAdsOperationParams
 import com.expediagroup.sdk.rapid.operations.GetAvailabilityOperation
 import com.expediagroup.sdk.rapid.operations.GetAvailabilityOperationParams
 import com.expediagroup.sdk.rapid.operations.GetBookingReceiptOperation
@@ -896,6 +898,92 @@ class RapidClient private constructor(clientConfiguration: RapidClientConfigurat
         }
     }
 
+    /**
+     *
+     * Returns relevant ads.
+     * @param operation [GetAdsOperation]
+     * @throws ExpediaGroupApiErrorException
+     * @return a [Response] object with a body of type AdsResponse
+     */
+    fun execute(operation: GetAdsOperation): Response<AdsResponse> = execute<AdsRequest, AdsResponse>(operation)
+
+    /**
+     *
+     * Returns relevant ads.
+     * @param operation [GetAdsOperation]
+     * @throws ExpediaGroupApiErrorException
+     * @return a [CompletableFuture<Response>] object with a body of type AdsResponse
+     */
+    fun executeAsync(operation: GetAdsOperation): CompletableFuture<Response<AdsResponse>> = executeAsync<AdsRequest, AdsResponse>(operation)
+
+    private suspend inline fun kgetAdsWithResponse(
+        customerIp: kotlin.String? =
+            null,
+        adsRequest: AdsRequest? =
+            null
+    ): Response<AdsResponse> {
+        val params =
+            GetAdsOperationParams(
+                customerIp = customerIp
+            )
+
+        val operation =
+            GetAdsOperation(
+                params,
+                adsRequest
+            )
+
+        return execute(operation)
+    }
+
+    /**
+     *
+     * Returns relevant ads.
+     * @param customerIp IP address of the customer, as captured by your integration. Ensure your integration passes the customer's IP, not your own. This value helps determine their location for ad relevancy. Also used for fraud recovery and other important analytics. (optional)
+     * @param adsRequest  (optional)
+     * @throws ExpediaGroupApiErrorException
+     * @return AdsResponse
+     */
+    @Throws(
+        ExpediaGroupApiErrorException::class
+    )
+    @JvmOverloads
+    @Deprecated("Use execute method instead", ReplaceWith("execute(operation: GetAdsOperation)"))
+    fun getAds(
+        customerIp: kotlin.String? =
+            null,
+        adsRequest: AdsRequest? =
+            null
+    ): AdsResponse = getAdsWithResponse(customerIp, adsRequest).data
+
+    /**
+     *
+     * Returns relevant ads.
+     * @param customerIp IP address of the customer, as captured by your integration. Ensure your integration passes the customer's IP, not your own. This value helps determine their location for ad relevancy. Also used for fraud recovery and other important analytics. (optional)
+     * @param adsRequest  (optional)
+     * @throws ExpediaGroupApiErrorException
+     * @return a [Response] object with a body of type AdsResponse
+     */
+    @Throws(
+        ExpediaGroupApiErrorException::class
+    )
+    @JvmOverloads
+    @Deprecated("Use execute method instead", ReplaceWith("execute(operation: GetAdsOperation)"))
+    fun getAdsWithResponse(
+        customerIp: kotlin.String? =
+            null,
+        adsRequest: AdsRequest? =
+            null
+    ): Response<AdsResponse> {
+        try {
+            return GlobalScope.future(Dispatchers.IO) {
+                kgetAdsWithResponse(customerIp, adsRequest)
+            }.get()
+        } catch (exception: Exception) {
+            exception.handle()
+        }
+    }
+
     /**
      * Get property room rates and availability
      * Returns rates on available room types for specified properties (maximum of 250 properties per request).  The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. _Note_: If there are no available rooms, the response will be an empty array. * Multiple rooms of the same type may be requested by including multiple instances of the `occupancy` parameter. * The `nightly` array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the `stay` rate array, which details charges applied to the entire stay (each check-in).