commonMain.app.bsky.actor.searchActors.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluesky Show documentation

Bluesky Social API bindings for Kotlin.

The newest version!

@file:Suppress("DEPRECATION")

package app.bsky.actor

import kotlin.Any
import kotlin.Deprecated
import kotlin.Long
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlinx.collections.immutable.toImmutableList
import kotlinx.serialization.Serializable
import sh.christian.ozone.api.model.ReadOnlyList

/**
 * @param q Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene
 * query syntax is recommended.
 */
@Serializable
public data class SearchActorsQueryParams(
  @Deprecated("DEPRECATED: use 'q' instead.")
  public val term: String? = null,
  /**
   * Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query
   * syntax is recommended.
   */
  public val q: String? = null,
  public val limit: Long? = 25,
  public val cursor: String? = null,
) {
  init {
    require(limit == null || limit >= 1) {
      "limit must be >= 1, but was $limit"
    }
    require(limit == null || limit <= 100) {
      "limit must be <= 100, but was $limit"
    }
  }

  public fun asList(): ReadOnlyList> = buildList {
    add("term" to term)
    add("q" to q)
    add("limit" to limit)
    add("cursor" to cursor)
  }.toImmutableList()
}

@Serializable
public data class SearchActorsResponse(
  public val cursor: String? = null,
  public val actors: ReadOnlyList,
)