commonMain.com.algolia.client.model.search.SearchForFacetValuesRequest.kt Maven / Gradle / Ivy

Go to download
/** Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. */
package com.algolia.client.model.search

import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
 * SearchForFacetValuesRequest
 *
 * @param params Search parameters as a URL-encoded query string.
 * @param facetQuery Text to search inside the facet's values.
 * @param maxFacetHits Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
 */
@Serializable
public data class SearchForFacetValuesRequest(

  /** Search parameters as a URL-encoded query string. */
  @SerialName(value = "params") val params: String? = null,

  /** Text to search inside the facet's values. */
  @SerialName(value = "facetQuery") val facetQuery: String? = null,

  /** Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). */
  @SerialName(value = "maxFacetHits") val maxFacetHits: Int? = null,
)