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

import kotlin.String
import kotlin.Suppress
import kotlinx.serialization.Serializable
import sh.christian.ozone.api.AtIdentifier
import sh.christian.ozone.api.Cid
import sh.christian.ozone.api.Nsid

/**
 * @param repo The handle or DID of the repo (aka, current account).
 * @param collection The NSID of the record collection.
 * @param rkey The Record Key.
 * @param swapRecord Compare and swap with the previous record by CID.
 * @param swapCommit Compare and swap with the previous commit by CID.
 */
@Serializable
public data class DeleteRecordRequest(
  /**
   * The handle or DID of the repo (aka, current account).
   */
  public val repo: AtIdentifier,
  /**
   * The NSID of the record collection.
   */
  public val collection: Nsid,
  /**
   * The Record Key.
   */
  public val rkey: String,
  /**
   * Compare and swap with the previous record by CID.
   */
  public val swapRecord: Cid? = null,
  /**
   * Compare and swap with the previous commit by CID.
   */
  public val swapCommit: Cid? = null,
)

@Serializable
public data class DeleteRecordResponse(
  public val commit: CommitMeta? = null,
)