ozone/tools.ozone.moderation

Package-level declarations

Types

data class AccountEvent(val comment: String? = null, val active: Boolean, val status: Status? = null, val timestamp: Timestamp)

Logs account status related events on a repo subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.

AccountHosting

@Serializable

data class AccountHosting(val status: Status, val updatedAt: Timestamp? = null, val createdAt: Timestamp? = null, val deletedAt: Timestamp? = null, val deactivatedAt: Timestamp? = null, val reactivatedAt: Timestamp? = null)

BlobView

@Serializable

data class BlobView(val cid: Cid, val mimeType: String, val size: Long, val createdAt: Timestamp, val details: BlobViewDetailsUnion? = null, val moderation: Moderation? = null)

BlobViewDetailsUnion

@Serializable

sealed interface BlobViewDetailsUnion

EmitEventRequest

@Serializable

data class EmitEventRequest(val event: EmitEventRequestEventUnion, val subject: EmitEventRequestSubjectUnion, val subjectBlobCids: List<Cid> = emptyList(), val createdBy: Did)

EmitEventRequestEventUnion

@Serializable

sealed interface EmitEventRequestEventUnion

EmitEventRequestSubjectUnion

@Serializable

sealed interface EmitEventRequestSubjectUnion

EmitEventResponse

typealias EmitEventResponse = ModEventView

GetEventQueryParams

@Serializable

data class GetEventQueryParams(val id: Long)

GetEventResponse

typealias GetEventResponse = ModEventViewDetail

GetRecordQueryParams

@Serializable

data class GetRecordQueryParams(val uri: AtUri, val cid: Cid? = null)

GetRecordResponse

typealias GetRecordResponse = RecordViewDetail

GetRecordsQueryParams

@Serializable

data class GetRecordsQueryParams(val uris: List<AtUri>)

GetRecordsResponse

@Serializable

data class GetRecordsResponse(val records: List<GetRecordsResponseRecordUnion>)

GetRecordsResponseRecordUnion

@Serializable

sealed interface GetRecordsResponseRecordUnion

GetRepoQueryParams

@Serializable

data class GetRepoQueryParams(val did: Did)

GetRepoResponse

typealias GetRepoResponse = RepoViewDetail

GetReposQueryParams

@Serializable

data class GetReposQueryParams(val dids: List<Did>)

GetReposResponse

@Serializable

data class GetReposResponse(val repos: List<GetReposResponseRepoUnion>)

GetReposResponseRepoUnion

@Serializable

sealed interface GetReposResponseRepoUnion

IdentityEvent

@Serializable

data class IdentityEvent(val comment: String? = null, val handle: Handle? = null, val pdsHost: Uri? = null, val tombstone: Boolean? = null, val timestamp: Timestamp)

Logs identity related events on a repo subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.

ImageDetails

@Serializable

data class ImageDetails(val width: Long, val height: Long)

Moderation

@Serializable

data class Moderation(val subjectStatus: SubjectStatusView? = null)

ModerationDetail

@Serializable

data class ModerationDetail(val subjectStatus: SubjectStatusView? = null)

ModEventAcknowledge

@Serializable

data class ModEventAcknowledge(val comment: String? = null, val acknowledgeAccountSubjects: Boolean? = null)

ModEventComment

@Serializable

data class ModEventComment(val comment: String, val sticky: Boolean? = null)

Add a comment to a subject

ModEventDivert

@Serializable

data class ModEventDivert(val comment: String? = null)

Divert a record's blobs to a 3rd party service for further scanning/tagging

ModEventEmail

@Serializable

data class ModEventEmail(val subjectLine: String, val content: String? = null, val comment: String? = null)

Keep a log of outgoing email to a user

ModEventEscalate

@Serializable

data class ModEventEscalate(val comment: String? = null)

ModEventLabel

@Serializable

data class ModEventLabel(val comment: String? = null, val createLabelVals: List<String>, val negateLabelVals: List<String>)

Apply/Negate labels on a subject

ModEventMute

@Serializable

data class ModEventMute(val comment: String? = null, val durationInHours: Long)

Mute incoming reports on a subject

ModEventMuteReporter

@Serializable

data class ModEventMuteReporter(val comment: String? = null, val durationInHours: Long? = null)

Mute incoming reports from an account

ModEventReport

@Serializable

data class ModEventReport(val comment: String? = null, val isReporterMuted: Boolean? = null, val reportType: Token)

Report a subject

ModEventResolveAppeal

@Serializable

data class ModEventResolveAppeal(val comment: String? = null)

Resolve appeal on a subject

ModEventReverseTakedown

@Serializable

data class ModEventReverseTakedown(val comment: String? = null)

Revert take down action on a subject

ModEventTag

@Serializable

data class ModEventTag(val add: List<String>, val remove: List<String>, val comment: String? = null)

Add/Remove a tag on a subject

ModEventTakedown

@Serializable

data class ModEventTakedown(val comment: String? = null, val durationInHours: Long? = null, val acknowledgeAccountSubjects: Boolean? = null, val policies: List<String> = emptyList())

Take down a subject permanently or temporarily

ModEventUnmute

@Serializable

data class ModEventUnmute(val comment: String? = null)

Unmute action on a subject

ModEventUnmuteReporter

@Serializable

data class ModEventUnmuteReporter(val comment: String? = null)

Unmute incoming reports from an account

ModEventView

@Serializable

data class ModEventView(val id: Long, val event: ModEventViewEventUnion, val subject: ModEventViewSubjectUnion, val subjectBlobCids: List<String>, val createdBy: Did, val createdAt: Timestamp, val creatorHandle: String? = null, val subjectHandle: String? = null)

ModEventViewDetail

@Serializable

data class ModEventViewDetail(val id: Long, val event: ModEventViewDetailEventUnion, val subject: ModEventViewDetailSubjectUnion, val subjectBlobs: List<BlobView>, val createdBy: Did, val createdAt: Timestamp)

ModEventViewDetailEventUnion

@Serializable

sealed interface ModEventViewDetailEventUnion

ModEventViewDetailSubjectUnion

@Serializable

sealed interface ModEventViewDetailSubjectUnion

ModEventViewEventUnion

@Serializable

sealed interface ModEventViewEventUnion

ModEventViewSubjectUnion

@Serializable

sealed interface ModEventViewSubjectUnion

@Serializable(with = OpSerializer::class)

sealed class Op : AtpEnum

OpSerializer

class OpSerializer : KSerializer<Op>

QueryEventsQueryParams

@Serializable

data class QueryEventsQueryParams(val types: List<String> = emptyList(), val createdBy: Did? = null, val sortDirection: String? = "desc", val createdAfter: Timestamp? = null, val createdBefore: Timestamp? = null, val subject: Uri? = null, val collections: List<Nsid> = emptyList(), val subjectType: QueryEventsSubjectType? = null, val includeAllUserRecords: Boolean? = false, val limit: Long? = 50, val hasComment: Boolean? = null, val comment: String? = null, val addedLabels: List<String> = emptyList(), val removedLabels: List<String> = emptyList(), val addedTags: List<String> = emptyList(), val removedTags: List<String> = emptyList(), val reportTypes: List<String> = emptyList(), val policies: List<String> = emptyList(), val cursor: String? = null)

QueryEventsResponse

@Serializable

data class QueryEventsResponse(val cursor: String? = null, val events: List<ModEventView>)

QueryEventsSubjectType

@Serializable(with = QueryEventsSubjectTypeSerializer::class)

sealed class QueryEventsSubjectType : AtpEnum

If specified, only events where the subject is of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.

QueryEventsSubjectTypeSerializer

class QueryEventsSubjectTypeSerializer : KSerializer<QueryEventsSubjectType>

QueryStatusesQueryParams

@Serializable

data class QueryStatusesQueryParams(val queueCount: Long? = null, val queueIndex: Long? = null, val queueSeed: String? = null, val includeAllUserRecords: Boolean? = null, val subject: Uri? = null, val comment: String? = null, val reportedAfter: Timestamp? = null, val reportedBefore: Timestamp? = null, val reviewedAfter: Timestamp? = null, val hostingDeletedAfter: Timestamp? = null, val hostingDeletedBefore: Timestamp? = null, val hostingUpdatedAfter: Timestamp? = null, val hostingUpdatedBefore: Timestamp? = null, val hostingStatuses: List<String> = emptyList(), val reviewedBefore: Timestamp? = null, val includeMuted: Boolean? = null, val onlyMuted: Boolean? = null, val reviewState: String? = null, val ignoreSubjects: List<Uri> = emptyList(), val lastReviewedBy: Did? = null, val sortField: String? = "lastReportedAt", val sortDirection: String? = "desc", val takendown: Boolean? = null, val appealed: Boolean? = null, val limit: Long? = 50, val tags: List<String> = emptyList(), val excludeTags: List<String> = emptyList(), val cursor: String? = null, val collections: List<Nsid> = emptyList(), val subjectType: QueryStatusesSubjectType? = null)

QueryStatusesResponse

@Serializable

data class QueryStatusesResponse(val cursor: String? = null, val subjectStatuses: List<SubjectStatusView>)

QueryStatusesSubjectType

@Serializable(with = QueryStatusesSubjectTypeSerializer::class)

sealed class QueryStatusesSubjectType : AtpEnum

If specified, subjects of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.

QueryStatusesSubjectTypeSerializer

class QueryStatusesSubjectTypeSerializer : KSerializer<QueryStatusesSubjectType>

RecordEvent

@Serializable

data class RecordEvent(val comment: String? = null, val op: Op, val cid: Cid? = null, val timestamp: Timestamp)

Logs lifecycle event on a record subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.

RecordHosting

@Serializable

data class RecordHosting(val status: Status, val updatedAt: Timestamp? = null, val createdAt: Timestamp? = null, val deletedAt: Timestamp? = null)

RecordView

@Serializable

data class RecordView(val uri: AtUri, val cid: Cid, val value: JsonContent, val blobCids: List<Cid>, val indexedAt: Timestamp, val moderation: Moderation, val repo: RepoView)

RecordViewDetail

@Serializable

data class RecordViewDetail(val uri: AtUri, val cid: Cid, val value: JsonContent, val blobs: List<BlobView>, val labels: List<Label> = emptyList(), val indexedAt: Timestamp, val moderation: ModerationDetail, val repo: RepoView)

RecordViewNotFound

@Serializable

data class RecordViewNotFound(val uri: AtUri)

RepoView

@Serializable

data class RepoView(val did: Did, val handle: Handle, val email: String? = null, val relatedRecords: List<JsonContent>, val indexedAt: Timestamp, val moderation: Moderation, val invitedBy: InviteCode? = null, val invitesDisabled: Boolean? = null, val inviteNote: String? = null, val deactivatedAt: Timestamp? = null, val threatSignatures: List<ThreatSignature> = emptyList())

RepoViewDetail

@Serializable

data class RepoViewDetail(val did: Did, val handle: Handle, val email: String? = null, val relatedRecords: List<JsonContent>, val indexedAt: Timestamp, val moderation: ModerationDetail, val labels: List<Label> = emptyList(), val invitedBy: InviteCode? = null, val invites: List<InviteCode> = emptyList(), val invitesDisabled: Boolean? = null, val inviteNote: String? = null, val emailConfirmedAt: Timestamp? = null, val deactivatedAt: Timestamp? = null, val threatSignatures: List<ThreatSignature> = emptyList())

RepoViewNotFound

@Serializable

data class RepoViewNotFound(val did: Did)

SearchReposQueryParams

@Serializable

data class SearchReposQueryParams(val term: String? = null, val q: String? = null, val limit: Long? = 50, val cursor: String? = null)

SearchReposResponse

@Serializable

data class SearchReposResponse(val cursor: String? = null, val repos: List<RepoView>)

Status

@Serializable(with = StatusSerializer::class)

sealed class Status : AtpEnum

StatusSerializer

class StatusSerializer : KSerializer<Status>

SubjectStatusView

@Serializable

data class SubjectStatusView(val id: Long, val subject: SubjectStatusViewSubjectUnion, val hosting: SubjectStatusViewHostingUnion? = null, val subjectBlobCids: List<Cid> = emptyList(), val subjectRepoHandle: String? = null, val updatedAt: Timestamp, val createdAt: Timestamp, val reviewState: Token, val comment: String? = null, val muteUntil: Timestamp? = null, val muteReportingUntil: Timestamp? = null, val lastReviewedBy: Did? = null, val lastReviewedAt: Timestamp? = null, val lastReportedAt: Timestamp? = null, val lastAppealedAt: Timestamp? = null, val takendown: Boolean? = null, val appealed: Boolean? = null, val suspendUntil: Timestamp? = null, val tags: List<String> = emptyList())

SubjectStatusViewHostingUnion

@Serializable

sealed interface SubjectStatusViewHostingUnion

SubjectStatusViewSubjectUnion

@Serializable

sealed interface SubjectStatusViewSubjectUnion

Token

@Serializable(with = TokenSerializer::class)

sealed class Token : AtpEnum

TokenSerializer

class TokenSerializer : KSerializer<Token>

VideoDetails

@Serializable

data class VideoDetails(val width: Long, val height: Long, val length: Long)