Delete FacetQuery class

Author: q-litzler

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

@@ -6,7 +6,6 @@ import com.algolia.search.model.filter.Filter
 import com.algolia.search.model.response.ResponseSearch
 import com.algolia.search.model.response.ResponseSearchForFacets
 import com.algolia.search.model.search.Cursor
-import com.algolia.search.model.search.FacetQuery
 import com.algolia.search.model.search.Query
 import com.algolia.search.transport.RequestOptions
 
@@ -95,12 +94,14 @@ public interface EndpointSearch {
      * users can more easily drill down into the results. See more here.
      *
      * @param attribute The [Attribute] to facet on.
-     * @param query The [FacetQuery] used to search.
+     * @param facetQuery The facetQuery used to search for facets.
+     * @param query: The [Query] to filter results.
      * @param requestOptions Configure request locally with [RequestOptions].
      */
     suspend fun searchForFacets(
         attribute: Attribute,
-        query: FacetQuery = FacetQuery(),
+        facetQuery: String? = null,
+        query: Query = Query(),
         requestOptions: RequestOptions? = null
     ): ResponseSearchForFacets
 

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

@@ -11,7 +11,6 @@ import com.algolia.search.model.request.RequestParams
 import com.algolia.search.model.response.ResponseSearch
 import com.algolia.search.model.response.ResponseSearchForFacets
 import com.algolia.search.model.search.Cursor
-import com.algolia.search.model.search.FacetQuery
 import com.algolia.search.model.search.FacetStats
 import com.algolia.search.model.search.Query
 import com.algolia.search.serialize.*
@@ -49,14 +48,15 @@ internal class EndpointSearchImpl(
 
     override suspend fun searchForFacets(
         attribute: Attribute,
-        query: FacetQuery,
+        facetQuery: String?,
+        query: Query,
         requestOptions: RequestOptions?
     ): ResponseSearchForFacets {
         val path = indexName.toPath("/facets/$attribute/query")
         val extraParams = json {
-            query.facetQuery?.let { KeyFacetQuery to it }
+            facetQuery?.let { KeyFacetQuery to it }
         }
-        val body = query.query.toJsonNoDefaults().merge(extraParams).toString()
+        val body = query.toJsonNoDefaults().merge(extraParams).toString()
 
         return transport.request(HttpMethod.Post, CallType.Read, path, requestOptions, body)
     }

src/commonMain/kotlin/com/algolia/search/model/search/FacetQuery.kt

@@ -2,7 +2,6 @@ package documentation.methods.search
 
 import com.algolia.search.dsl.requestOptions
 import com.algolia.search.model.Attribute
-import com.algolia.search.model.search.FacetQuery
 import com.algolia.search.model.search.Query
 import documentation.index
 import runBlocking
@@ -15,53 +14,38 @@ internal class DocSearchForFacets {
 
 //    suspend fun Index.searchForFacets(
 //        #{attribute}: __Attribute__,
-//        #{query}: __FacetQuery__ = FacetQuery(),
+//        #{facetQuery}: __String?__ = null,
+//        [query](#searchParameters): __Query?__ = Query(),
 //        #{requestOptions}: __RequestOptions?__ = null
 //    ): ResponseSearchForFacetValues
-//
-//    data class FacetQuery(
-//        var #{facetQuery}: __String__? = null,
-//        var #{query}: __Query?__ = null,
-//    )
-//
-//    // any #{searchParameters} can be set on the Query object
 
     @Test
     fun snippet1() {
         runBlocking {
             val attribute = Attribute("category")
-            val query = FacetQuery(facetQuery = "phone")
 
-            index.searchForFacets(attribute, query)
+            index.searchForFacets(attribute, "phone")
         }
     }
 
     @Test
     fun snippet2() {
         runBlocking {
             val attribute = Attribute("category")
-            val query = FacetQuery(
-                facetQuery = "phone",
-                query = Query(filters = "brand:Apple")
-            )
 
-            index.searchForFacets(attribute, query)
+            index.searchForFacets(attribute, "phone", Query(filters = "brand:Apple"))
         }
     }
 
     @Test
     fun snippet3() {
         runBlocking {
             val attribute = Attribute("category")
-            val query = FacetQuery(
-                facetQuery = "phone",
-                query = Query(filters = "brand:Apple")
-            )
             val requestOptions = requestOptions {
                 header("X-Algolia-User-ID", "user123")
             }
 
-            index.searchForFacets(attribute, query, requestOptions)
+            index.searchForFacets(attribute, "phone", Query(filters = "brand:Apple"), requestOptions)
         }
     }
 }

src/commonTest/kotlin/documentation/methods/search/DocSearchForFacets.kt

@@ -3,7 +3,6 @@ package suite
 import clientAdmin1
 import clientSearch
 import com.algolia.search.helper.toAttribute
-import com.algolia.search.model.search.FacetQuery
 import com.algolia.search.model.search.Query
 import com.algolia.search.model.settings.AttributeForFaceting
 import com.algolia.search.model.settings.Settings
@@ -58,8 +57,7 @@ internal class TestSuiteSearch {
             search.apply {
                 search(Query(facets = allFacets, filters = "company:tesla")).nbHits shouldEqual 1
                 search(Query(facets = allFacets, filters = "(company:tesla OR company:spacex)")).nbHits shouldEqual 2
-                val query = FacetQuery("a")
-                val response = searchForFacets(company, query)
+                val response = searchForFacets(company, "a")
                 val facetHits = response.facets.map { it.value }
 
                 facetHits shouldContain "Algolia"