Add hasPendingMapping to MultiCluster endpoints

Author: q-litzler

src/commonMain/kotlin/com/algolia/search/endpoint/EndpointMultiCluster.kt

@@ -114,4 +114,13 @@ public interface EndpointMultiCluster {
         clusterName: ClusterName,
         requestOptions: RequestOptions? = null
     ): Creation
+
+    /**
+     * @param retrieveMapping If set to true, retrieves [ResponseHasPendingMapping.clusters].
+     * @param requestOptions Configure request locally with [RequestOptions].
+     */
+    suspend fun hasPendingMapping(
+        retrieveMapping: Boolean = false,
+        requestOptions: RequestOptions? = null
+    ): ResponseHasPendingMapping
 }

src/commonMain/kotlin/com/algolia/search/endpoint/EndpointMulticlusterImpl.kt

@@ -89,4 +89,16 @@ internal class EndpointMulticlusterImpl(
 
         return transport.request(HttpMethod.Post, CallType.Write, path, requestOptions, body)
     }
+
+    override suspend fun hasPendingMapping(
+        retrieveMapping: Boolean,
+        requestOptions: RequestOptions?
+    ): ResponseHasPendingMapping {
+        val path = "$RouteClustersV1/mapping/pending"
+        val options = requestOptionsBuilder(requestOptions) {
+            parameter(KeyGetClusters, retrieveMapping)
+        }
+
+        return transport.request(HttpMethod.Get, CallType.Read, path, options)
+    }
 }

src/commonMain/kotlin/com/algolia/search/model/response/ResponseHasPendingMapping.kt

@@ -0,0 +1,15 @@
+package com.algolia.search.model.response
+
+import com.algolia.search.model.multicluster.ClusterName
+import com.algolia.search.model.multicluster.UserID
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+import com.algolia.search.serialize.KeyPending
+import com.algolia.search.serialize.KeyClusters
+
+
+@Serializable
+public data class ResponseHasPendingMapping(
+    @SerialName(KeyPending) val isPending: Boolean,
+    @SerialName(KeyClusters) val clusters: Map<ClusterName, List<UserID>>? = null
+)

src/commonMain/kotlin/com/algolia/search/serialize/KeysTwo.kt

@@ -171,3 +171,5 @@ public const val KeyIndexLanguages = "indexLanguages"
 public const val KeyCustomNormalization = "customNormalization"
 public const val KeyFilterPromotes = "filterPromotes"
 public const val KeyUsers = "users"
+public const val KeyPending = "pending"
+public const val KeyGetClusters = "getClusters"

src/commonTest/kotlin/serialize/TestKeys.kt

@@ -358,5 +358,7 @@ internal class TestKeys {
         KeyCustomNormalization shouldEqual "customNormalization"
         KeyFilterPromotes shouldEqual "filterPromotes"
         KeyUsers shouldEqual "users"
+        KeyPending shouldEqual "pending"
+        KeyGetClusters shouldEqual "getClusters"
     }
 }

src/commonTest/kotlin/suite/TestSuiteMultiCluster.kt

@@ -13,6 +13,7 @@ import kotlinx.coroutines.delay
 import kotlinx.coroutines.isActive
 import kotlinx.io.core.String
 import runBlocking
+import shouldBeFalse
 import shouldBeTrue
 import shouldEqual
 import shouldNotBeEmpty
@@ -87,6 +88,7 @@ internal class TestSuiteMultiCluster {
             clientMcm.listUserIDs().userIDs.filter { it.userID.raw.startsWith(prefix) }.forEach {
                 clientMcm.removeUserID(it.userID)
             }
+            clientMcm.hasPendingMapping(true).clusters.isNullOrEmpty().shouldBeFalse()
         }
     }
 }