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

/**
 * `searchDictionaryEntries` parameters.
 *
 * @param query Text to search for in an index.
 * @param page Page to retrieve (the first page is `0`, not `1`).
 * @param hitsPerPage Number of hits per page.
 * @param language [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
 */
@Serializable
public data class SearchDictionaryEntriesParams(

  /** Text to search for in an index. */
  @SerialName(value = "query") val query: String,

  /** Page to retrieve (the first page is `0`, not `1`). */
  @SerialName(value = "page") val page: Int? = null,

  /** Number of hits per page. */
  @SerialName(value = "hitsPerPage") val hitsPerPage: Int? = null,

  /** [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).  */
  @SerialName(value = "language") val language: String? = null,
)