ozone/com.atproto.server

Package-level declarations

Types

CheckAccountStatusResponse

data class CheckAccountStatusResponse(val activated: Boolean, val validDid: Boolean, val repoCommit: Cid, val repoRev: String, val repoBlocks: Long, val indexedRecords: Long, val privateStateValues: Long, val expectedBlobs: Long, val importedBlobs: Long)

ConfirmEmailRequest

data class ConfirmEmailRequest(val email: String, val token: String)

CreateAccountRequest

data class CreateAccountRequest(val email: String? = null, val handle: Handle, val did: Did? = null, val inviteCode: String? = null, val verificationCode: String? = null, val verificationPhone: String? = null, val password: String? = null, val recoveryKey: String? = null, val plcOp: JsonContent? = null)

CreateAccountResponse

data class CreateAccountResponse(val accessJwt: String, val refreshJwt: String, val handle: Handle, val did: Did, val didDoc: JsonContent? = null)

Account login session returned on successful account creation.

CreateAppPasswordAppPassword

data class CreateAppPasswordAppPassword(val name: String, val password: String, val createdAt: Timestamp, val privileged: Boolean? = null)

CreateAppPasswordRequest

data class CreateAppPasswordRequest(val name: String, val privileged: Boolean? = null)

CreateAppPasswordResponse

typealias CreateAppPasswordResponse = CreateAppPasswordAppPassword

CreateInviteCodeRequest

data class CreateInviteCodeRequest(val useCount: Long, val forAccount: Did? = null)

CreateInviteCodeResponse

data class CreateInviteCodeResponse(val code: String)

CreateInviteCodesAccountCodes

data class CreateInviteCodesAccountCodes(val account: String, val codes: List<String>)

CreateInviteCodesRequest

data class CreateInviteCodesRequest(val codeCount: Long, val useCount: Long, val forAccounts: List<Did> = emptyList())

CreateInviteCodesResponse

data class CreateInviteCodesResponse(val codes: List<CreateInviteCodesAccountCodes>)

CreateSessionRequest

data class CreateSessionRequest(val identifier: String, val password: String, val authFactorToken: String? = null, val allowTakendown: Boolean? = null)

CreateSessionResponse

data class CreateSessionResponse(val accessJwt: String, val refreshJwt: String, val handle: Handle, val did: Did, val didDoc: JsonContent? = null, val email: String? = null, val emailConfirmed: Boolean? = null, val emailAuthFactor: Boolean? = null, val active: Boolean? = null, val status: CreateSessionStatus? = null)

CreateSessionStatus

@Serializable(with = CreateSessionStatusSerializer::class)

sealed class CreateSessionStatus : AtpEnum

If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

CreateSessionStatusSerializer

class CreateSessionStatusSerializer : KSerializer<CreateSessionStatus>

DeactivateAccountRequest

data class DeactivateAccountRequest(val deleteAfter: Timestamp? = null)

DeleteAccountRequest

data class DeleteAccountRequest(val did: Did, val password: String, val token: String)

DescribeServerContact

data class DescribeServerContact(val email: String? = null)

DescribeServerLinks

data class DescribeServerLinks(val privacyPolicy: Uri? = null, val termsOfService: Uri? = null)

DescribeServerResponse

data class DescribeServerResponse(val inviteCodeRequired: Boolean? = null, val phoneVerificationRequired: Boolean? = null, val availableUserDomains: List<String>, val links: DescribeServerLinks? = null, val contact: DescribeServerContact? = null, val did: Did)

GetAccountInviteCodesQueryParams

data class GetAccountInviteCodesQueryParams(val includeUsed: Boolean? = true, val createAvailable: Boolean? = true)

GetAccountInviteCodesResponse

data class GetAccountInviteCodesResponse(val codes: List<InviteCode>)

GetServiceAuthQueryParams

data class GetServiceAuthQueryParams(val aud: Did, val exp: Long? = null, val lxm: Nsid? = null)

GetServiceAuthResponse

data class GetServiceAuthResponse(val token: String)

GetSessionResponse

data class GetSessionResponse(val handle: Handle, val did: Did, val email: String? = null, val emailConfirmed: Boolean? = null, val emailAuthFactor: Boolean? = null, val didDoc: JsonContent? = null, val active: Boolean? = null, val status: GetSessionStatus? = null)

GetSessionStatus

@Serializable(with = GetSessionStatusSerializer::class)

sealed class GetSessionStatus : AtpEnum

If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

GetSessionStatusSerializer

class GetSessionStatusSerializer : KSerializer<GetSessionStatus>

data class InviteCode(val code: String, val available: Long, val disabled: Boolean, val forAccount: String, val createdBy: String, val createdAt: Timestamp, val uses: List<InviteCodeUse>)

data class InviteCodeUse(val usedBy: Did, val usedAt: Timestamp)

ListAppPasswordsAppPassword

data class ListAppPasswordsAppPassword(val name: String, val createdAt: Timestamp, val privileged: Boolean? = null)

ListAppPasswordsResponse

data class ListAppPasswordsResponse(val passwords: List<ListAppPasswordsAppPassword>)

RefreshSessionResponse

data class RefreshSessionResponse(val accessJwt: String, val refreshJwt: String, val handle: Handle, val did: Did, val didDoc: JsonContent? = null, val active: Boolean? = null, val status: RefreshSessionStatus? = null)

RefreshSessionStatus

@Serializable(with = RefreshSessionStatusSerializer::class)

sealed class RefreshSessionStatus : AtpEnum

Hosting status of the account. If not specified, then assume 'active'.

RefreshSessionStatusSerializer

class RefreshSessionStatusSerializer : KSerializer<RefreshSessionStatus>

RequestEmailUpdateResponse

data class RequestEmailUpdateResponse(val tokenRequired: Boolean)

RequestPasswordResetRequest

data class RequestPasswordResetRequest(val email: String)

ReserveSigningKeyRequest

data class ReserveSigningKeyRequest(val did: Did? = null)

ReserveSigningKeyResponse

data class ReserveSigningKeyResponse(val signingKey: String)

ResetPasswordRequest

data class ResetPasswordRequest(val token: String, val password: String)

RevokeAppPasswordRequest

data class RevokeAppPasswordRequest(val name: String)

UpdateEmailRequest

data class UpdateEmailRequest(val email: String, val emailAuthFactor: Boolean? = null, val token: String? = null)