commonMain.com.algolia.client.model.recommend.RecommendRule.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-jvm 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.10.1

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.recommend

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

/**
 * Recommend rule.
 *
 * @param metadata
 * @param objectID Unique identifier of a rule object.
 * @param condition
 * @param consequence
 * @param description Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
 * @param enabled Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
 * @param validity Time periods when the rule is active.
 */
@Serializable
public data class RecommendRule(

  @SerialName(value = "_metadata") val metadata: RuleMetadata? = null,

  /** Unique identifier of a rule object. */
  @SerialName(value = "objectID") val objectID: String? = null,

  @SerialName(value = "condition") val condition: Condition? = null,

  @SerialName(value = "consequence") val consequence: Consequence? = null,

  /** Description of the rule's purpose. This can be helpful for display in the Algolia dashboard. */
  @SerialName(value = "description") val description: String? = null,

  /** Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time. */
  @SerialName(value = "enabled") val enabled: Boolean? = null,

  /** Time periods when the rule is active. */
  @SerialName(value = "validity") val validity: List? = null,
)