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

/**
 * Record to promote.
 *
 * @param objectID Unique identifier of the record to promote.
 * @param position The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
 */
@Serializable
public data class PromoteObjectID(

  /** Unique identifier of the record to promote. */
  @SerialName(value = "objectID") val objectID: String,

  /** The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions. */
  @SerialName(value = "position") val position: Int,
) : Promote