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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-client-kotlin Show documentation

"Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search REST API from your JVM project, such as Android or backend implementations."

There is a newer version: 3.13.0

Show newest version

/** 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.*

/**
 * Rules search parameters.
 *
 * @param query Rule object query.
 * @param anchoring
 * @param context Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
 * @param page Requested page (the first page is page 0).
 * @param hitsPerPage Maximum number of hits per page.
 * @param enabled Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
 * @param requestOptions Request options to send with the API call.
 */
@Serializable
public data class SearchRulesParams(

  /** Rule object query. */
  @SerialName(value = "query") val query: String? = null,

  @SerialName(value = "anchoring") val anchoring: Anchoring? = null,

  /** Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules). */
  @SerialName(value = "context") val context: String? = null,

  /** Requested page (the first page is page 0). */
  @SerialName(value = "page") val page: Int? = null,

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

  /** Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved. */
  @SerialName(value = "enabled") val enabled: Boolean? = null,

  /** Request options to send with the API call. */
  @SerialName(value = "requestOptions") val requestOptions: List? = null,
)