commonMain.com.algolia.client.model.search.SearchForFacetsOptions.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.*

/**
 * SearchForFacetsOptions
 *
 * @param facet Facet name.
 * @param indexName Index name (case-sensitive).
 * @param type
 * @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 SearchForFacetsOptions(

  /** Facet name. */
  @SerialName(value = "facet") val facet: String,

  /** Index name (case-sensitive). */
  @SerialName(value = "indexName") val indexName: String,

  @SerialName(value = "type") val type: SearchTypeFacet,

  /** 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,
)