commonMain.com.algolia.client.model.querysuggestions.ConfigurationResponse.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.querysuggestions

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

/**
 * API response for retrieving Query Suggestions configurations.
 *
 * @param appID Algolia application ID to which this Query Suggestions configuration belongs.
 * @param indexName Name of the Query Suggestions index (case-sensitive).
 * @param sourceIndices Algolia indices from which to get the popular searches for query suggestions.
 * @param languages
 * @param exclude
 * @param enablePersonalization Whether to turn on personalized query suggestions.
 * @param allowSpecialCharacters Whether to include suggestions with special characters.
 */
@Serializable
public data class ConfigurationResponse(

  /** Algolia application ID to which this Query Suggestions configuration belongs. */
  @SerialName(value = "appID") val appID: String,

  /** Name of the Query Suggestions index (case-sensitive). */
  @SerialName(value = "indexName") val indexName: String,

  /** Algolia indices from which to get the popular searches for query suggestions. */
  @SerialName(value = "sourceIndices") val sourceIndices: List,

  @SerialName(value = "languages") val languages: Languages,

  @SerialName(value = "exclude") val exclude: List,

  /** Whether to turn on personalized query suggestions. */
  @SerialName(value = "enablePersonalization") val enablePersonalization: Boolean,

  /** Whether to include suggestions with special characters. */
  @SerialName(value = "allowSpecialCharacters") val allowSpecialCharacters: Boolean,
)