commonMain.tools.ozone.communication.updateTemplate.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 tools.ozone.communication

import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlinx.serialization.Serializable
import sh.christian.ozone.api.Did
import sh.christian.ozone.api.Language

/**
 * @param id ID of the template to be updated.
 * @param name Name of the template.
 * @param lang Message language.
 * @param contentMarkdown Content of the template, markdown supported, can contain variable
 * placeholders.
 * @param subject Subject of the message, used in emails.
 * @param updatedBy DID of the user who is updating the template.
 */
@Serializable
public data class UpdateTemplateRequest(
  /**
   * ID of the template to be updated.
   */
  public val id: String,
  /**
   * Name of the template.
   */
  public val name: String? = null,
  /**
   * Message language.
   */
  public val lang: Language? = null,
  /**
   * Content of the template, markdown supported, can contain variable placeholders.
   */
  public val contentMarkdown: String? = null,
  /**
   * Subject of the message, used in emails.
   */
  public val subject: String? = null,
  /**
   * DID of the user who is updating the template.
   */
  public val updatedBy: Did? = null,
  public val disabled: Boolean? = null,
)

public typealias UpdateTemplateResponse = TemplateView