commonMain.com.atproto.repo.describeRepo.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.

There is a newer version: 0.3.1

@file:Suppress("DEPRECATION")

package com.atproto.repo

import kotlin.Any
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlinx.collections.immutable.toImmutableList
import kotlinx.serialization.Serializable
import sh.christian.ozone.api.AtIdentifier
import sh.christian.ozone.api.Did
import sh.christian.ozone.api.Handle
import sh.christian.ozone.api.Nsid
import sh.christian.ozone.api.model.JsonContent
import sh.christian.ozone.api.model.ReadOnlyList

/**
 * @param repo The handle or DID of the repo.
 */
@Serializable
public data class DescribeRepoQueryParams(
  /**
   * The handle or DID of the repo.
   */
  public val repo: AtIdentifier,
) {
  public fun asList(): ReadOnlyList> = buildList {
    add("repo" to repo)
  }.toImmutableList()
}

/**
 * @param didDoc The complete DID document for this account.
 * @param handleIsCorrect Indicates if handle is currently valid (resolves bi-directionally)
 */
@Serializable
public data class DescribeRepoResponse(
  public val handle: Handle,
  public val did: Did,
  /**
   * The complete DID document for this account.
   */
  public val didDoc: JsonContent,
  public val collections: ReadOnlyList,
  /**
   * Indicates if handle is currently valid (resolves bi-directionally)
   */
  public val handleIsCorrect: Boolean,
)