Package-level declarations

Types

Link copied to clipboard
data class AccountEvent(val comment: String? = null, val active: Boolean, val status: AccountEventStatus? = 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.

Link copied to clipboard
data class AccountHosting(val status: AccountHostingStatus, val updatedAt: Timestamp? = null, val createdAt: Timestamp? = null, val deletedAt: Timestamp? = null, val deactivatedAt: Timestamp? = null, val reactivatedAt: Timestamp? = null)
Link copied to clipboard
data class AccountStats(val reportCount: Long? = null, val appealCount: Long? = null, val suspendCount: Long? = null, val escalateCount: Long? = null, val takedownCount: Long? = null)

Statistics about a particular account subject

Link copied to clipboard
data class AccountStrike(val activeStrikeCount: Long? = null, val totalStrikeCount: Long? = null, val firstStrikeAt: Timestamp? = null, val lastStrikeAt: Timestamp? = null)

Strike information for an account

Link copied to clipboard
data class AgeAssuranceEvent(val createdAt: Timestamp, val attemptId: String, val status: AgeAssuranceEventStatus, val access: Access? = null, val countryCode: String? = null, val regionCode: String? = null, val initIp: String? = null, val initUa: String? = null, val completeIp: String? = null, val completeUa: String? = null)

Age assurance info coming directly from users. Only works on DID subjects.

Link copied to clipboard

The status of the Age Assurance process.

Link copied to clipboard
data class AgeAssuranceOverrideEvent(val status: AgeAssuranceOverrideEventStatus, val access: Access? = null, val comment: String)

Age assurance status override by moderators. Only works on DID subjects.

Link copied to clipboard

The status to be set for the user decided by a moderator, overriding whatever value the user had previously. Use reset to default to original state.

Link copied to clipboard
data class AgeAssurancePurgeEvent(val comment: String)

Purges all age assurance events for the subject. Only works on DID subjects. Moderator-only.

Link copied to clipboard
data class BlobView(val cid: Cid, val mimeType: String, val size: Long, val createdAt: Timestamp, val details: BlobViewDetailsUnion? = null, val moderation: Moderation? = null)
Link copied to clipboard
Link copied to clipboard
data class CancelScheduledActionsFailedCancellation(val did: Did, val error: String, val errorCode: String? = null)
Link copied to clipboard
data class CancelScheduledActionsRequest(val subjects: List<Did>, val comment: String? = null)
Link copied to clipboard
data class CancelScheduledTakedownEvent(val comment: String? = null)

Logs cancellation of a scheduled takedown action for an account.

Link copied to clipboard
data class ConvoView(val did: Did, val convoId: String)
Link copied to clipboard
data class EmitEventReportAction(val ids: List<Long>? = null, val types: List<String>? = null, val all: Boolean? = null, val note: String? = null)

Target specific reports when emitting a moderation event

Link copied to clipboard
data class EmitEventRequest(val event: EmitEventRequestEventUnion, val subject: EmitEventRequestSubjectUnion, val subjectBlobCids: List<Cid>? = null, val createdBy: Did, val modTool: ModTool? = null, val externalId: String? = null, val reportAction: EmitEventReportAction? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class GetRecordQueryParams(val uri: AtUri, val cid: Cid? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class GetRepoQueryParams(val did: Did)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class GetReposQueryParams(val dids: List<Did>)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class GetSubjectsQueryParams(val subjects: List<String>)
Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard
data class ImageDetails(val width: Long, val height: Long)
Link copied to clipboard
data class ListScheduledActionsRequest(val startsAfter: Timestamp? = null, val endsBefore: Timestamp? = null, val subjects: List<Did>? = null, val statuses: List<ListScheduledActionsStatuses>, val limit: Long? = 50, val cursor: String? = null)
Link copied to clipboard
data class ListScheduledActionsResponse(val actions: List<ScheduledActionView>, val cursor: String? = null)
Link copied to clipboard
data class Moderation(val subjectStatus: SubjectStatusView? = null)
Link copied to clipboard
data class ModerationDetail(val subjectStatus: SubjectStatusView? = null)
Link copied to clipboard
data class ModEventAcknowledge(val comment: String? = null, val acknowledgeAccountSubjects: Boolean? = null)
Link copied to clipboard
data class ModEventComment(val comment: String? = null, val sticky: Boolean? = null)

Add a comment to a subject. An empty comment will clear any previously set sticky comment.

Link copied to clipboard
data class ModEventDivert(val comment: String? = null)

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

Link copied to clipboard
data class ModEventEmail(val subjectLine: String, val content: String? = null, val comment: String? = null, val policies: List<String>? = null, val severityLevel: String? = null, val strikeCount: Long? = null, val strikeExpiresAt: Timestamp? = null, val isDelivered: Boolean? = null)

Keep a log of outgoing email to a user

Link copied to clipboard
data class ModEventEscalate(val comment: String? = null)
Link copied to clipboard
data class ModEventLabel(val comment: String? = null, val createLabelVals: List<String>, val negateLabelVals: List<String>, val durationInHours: Long? = null)

Apply/Negate labels on a subject

Link copied to clipboard
data class ModEventMute(val comment: String? = null, val durationInHours: Long)

Mute incoming reports on a subject

Link copied to clipboard
data class ModEventMuteReporter(val comment: String? = null, val durationInHours: Long? = null)

Mute incoming reports from an account

Link copied to clipboard
data class ModEventPriorityScore(val comment: String? = null, val score: Long)

Set priority score of the subject. Higher score means higher priority.

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

Report a subject

Link copied to clipboard
data class ModEventResolveAppeal(val comment: String? = null)

Resolve appeal on a subject

Link copied to clipboard
data class ModEventReverseTakedown(val comment: String? = null, val policies: List<String>? = null, val severityLevel: String? = null, val strikeCount: Long? = null)

Revert take down action on a subject

Link copied to clipboard
data class ModEventTag(val add: List<String>, val remove: List<String>, val comment: String? = null, val durationInHours: Long? = null)

Add/Remove a tag on a subject

Link copied to clipboard
data class ModEventTakedown(val comment: String? = null, val durationInHours: Long? = null, val acknowledgeAccountSubjects: Boolean? = null, val policies: List<String>? = null, val severityLevel: String? = null, val targetServices: List<ModEventTakedownTargetServices>? = null, val strikeCount: Long? = null, val strikeExpiresAt: Timestamp? = null)

Take down a subject permanently or temporarily

Link copied to clipboard
data class ModEventUnmute(val comment: String? = null)

Unmute action on a subject

Link copied to clipboard
data class ModEventUnmuteReporter(val comment: String? = null)

Unmute incoming reports from an account

Link copied to clipboard
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, val modTool: ModTool? = null)
Link copied to clipboard
data class ModEventViewDetail(val id: Long, val event: ModEventViewDetailEventUnion, val subject: ModEventViewDetailSubjectUnion, val subjectBlobs: List<BlobView>, val createdBy: Did, val createdAt: Timestamp, val modTool: ModTool? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class ModTool(val name: String, val meta: JsonContent? = null)

Moderation tool information for tracing the source of the action

Link copied to clipboard

If specified, only events where the age assurance state matches the given value are returned

Link copied to clipboard
data class QueryEventsQueryParams(val types: List<String>? = null, val createdBy: Did? = null, val sortDirection: String? = "desc", val createdAfter: Timestamp? = null, val createdBefore: Timestamp? = null, val subject: Uri? = null, val collections: List<Nsid>? = null, val subjectType: QueryEventsSubjectType? = null, val includeAllUserRecords: Boolean? = false, val limit: Long? = 50, val hasComment: Boolean? = null, val comment: String? = null, val addedLabels: List<String>? = null, val removedLabels: List<String>? = null, val addedTags: List<String>? = null, val removedTags: List<String>? = null, val reportTypes: List<String>? = null, val policies: List<String>? = null, val modTool: List<String>? = null, val batchId: String? = null, val ageAssuranceState: QueryEventsAgeAssuranceState? = null, val withStrike: Boolean? = null, val cursor: String? = null)
Link copied to clipboard
data class QueryEventsResponse(val cursor: String? = null, val events: List<ModEventView>)
Link copied to clipboard

If specified, only events where the subject is of the given type (account, record, or conversation) 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.

Link copied to clipboard

If specified, only subjects with the given age assurance state will be returned.

Link copied to clipboard
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>? = null, val reviewedBefore: Timestamp? = null, val includeMuted: Boolean? = null, val onlyMuted: Boolean? = null, val reviewState: String? = null, val ignoreSubjects: List<Uri>? = null, 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>? = null, val excludeTags: List<String>? = null, val cursor: String? = null, val collections: List<Nsid>? = null, val subjectType: QueryStatusesSubjectType? = null, val minAccountSuspendCount: Long? = null, val minReportedRecordsCount: Long? = null, val minTakendownRecordsCount: Long? = null, val minPriorityScore: Long? = null, val minStrikeCount: Long? = null, val ageAssuranceState: QueryStatusesAgeAssuranceState? = null)
Link copied to clipboard
data class QueryStatusesResponse(val cursor: String? = null, val subjectStatuses: List<SubjectStatusView>)
Link copied to clipboard

If specified, subjects of the given type (account, record, or conversation) 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.

Link copied to clipboard
data class RecordEvent(val comment: String? = null, val op: RecordEventOp, 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.

Link copied to clipboard
Link copied to clipboard
data class RecordHosting(val status: RecordHostingStatus, val updatedAt: Timestamp? = null, val createdAt: Timestamp? = null, val deletedAt: Timestamp? = null)
Link copied to clipboard
data class RecordsStats(val totalReports: Long? = null, val reportedCount: Long? = null, val escalatedCount: Long? = null, val appealedCount: Long? = null, val subjectCount: Long? = null, val pendingCount: Long? = null, val processedCount: Long? = null, val takendownCount: Long? = null)

Statistics about a set of record subject items

Link copied to clipboard
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)
Link copied to clipboard
data class RecordViewDetail(val uri: AtUri, val cid: Cid, val value: JsonContent, val blobs: List<BlobView>, val labels: List<Label>? = null, val indexedAt: Timestamp, val moderation: ModerationDetail, val repo: RepoView)
Link copied to clipboard
Link copied to clipboard
data class ReporterStats(val did: Did, val accountReportCount: Long, val recordReportCount: Long, val reportedAccountCount: Long, val reportedRecordCount: Long, val takendownAccountCount: Long, val takendownRecordCount: Long, val labeledAccountCount: Long, val labeledRecordCount: Long)
Link copied to clipboard
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>? = null)
Link copied to clipboard
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>? = null, val invitedBy: InviteCode? = null, val invites: List<InviteCode>? = null, val invitesDisabled: Boolean? = null, val inviteNote: String? = null, val emailConfirmedAt: Timestamp? = null, val deactivatedAt: Timestamp? = null, val threatSignatures: List<ThreatSignature>? = null)
Link copied to clipboard
data class RepoViewNotFound(val did: Did)
Link copied to clipboard

Account credentials revocation by moderators. Only works on DID subjects.

Link copied to clipboard
data class ScheduleActionFailedScheduling(val subject: Did, val error: String, val errorCode: String? = null)
Link copied to clipboard
data class ScheduleActionRequest(val action: ScheduleActionRequestActionUnion, val subjects: List<Did>, val createdBy: Did, val scheduling: ScheduleActionSchedulingConfig, val modTool: ModTool? = null)
Link copied to clipboard
data class ScheduleActionSchedulingConfig(val executeAt: Timestamp? = null, val executeAfter: Timestamp? = null, val executeUntil: Timestamp? = null)

Configuration for when the action should be executed

Link copied to clipboard
data class ScheduleActionTakedown(val comment: String? = null, val durationInHours: Long? = null, val acknowledgeAccountSubjects: Boolean? = null, val policies: List<String>? = null, val severityLevel: String? = null, val strikeCount: Long? = null, val strikeExpiresAt: Timestamp? = null, val emailContent: String? = null, val emailSubject: String? = null)

Schedule a takedown action

Link copied to clipboard
data class ScheduledActionView(val id: Long, val action: ScheduledActionViewAction, val eventData: JsonContent? = null, val did: Did, val executeAt: Timestamp? = null, val executeAfter: Timestamp? = null, val executeUntil: Timestamp? = null, val randomizeExecution: Boolean? = null, val createdBy: Did, val createdAt: Timestamp, val updatedAt: Timestamp? = null, val status: ScheduledActionViewStatus, val lastExecutedAt: Timestamp? = null, val lastFailureReason: String? = null, val executionEventId: Long? = null)

View of a scheduled moderation action

Link copied to clipboard
Link copied to clipboard

Current status of the scheduled action

Link copied to clipboard
data class ScheduleTakedownEvent(val comment: String? = null, val executeAt: Timestamp? = null, val executeAfter: Timestamp? = null, val executeUntil: Timestamp? = null)

Logs a scheduled takedown action for an account.

Link copied to clipboard
data class SearchReposQueryParams(val term: String? = null, val q: String? = null, val limit: Long? = 50, val cursor: String? = null)
Link copied to clipboard
data class SearchReposResponse(val cursor: String? = null, val repos: List<RepoView>)
Link copied to clipboard
data class SubjectStatusView(val id: Long, val subject: SubjectStatusViewSubjectUnion, val hosting: SubjectStatusViewHostingUnion? = null, val subjectBlobCids: List<Cid>? = null, val subjectRepoHandle: String? = null, val updatedAt: Timestamp, val createdAt: Timestamp, val reviewState: Token, val comment: String? = null, val priorityScore: Long? = 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>? = null, val accountStats: AccountStats? = null, val recordsStats: RecordsStats? = null, val accountStrike: AccountStrike? = null, val ageAssuranceState: SubjectStatusViewAgeAssuranceState? = null, val ageAssuranceUpdatedBy: SubjectStatusViewAgeAssuranceUpdatedBy? = null)
Link copied to clipboard
Link copied to clipboard

Whether or not the last successful update to age assurance was made by the user or admin.

Link copied to clipboard
data class SubjectView(val type: SubjectType, val subject: String, val status: SubjectStatusView? = null, val repo: RepoViewDetail? = null, val profile: SubjectViewProfileUnion? = null, val record: RecordViewDetail? = null)

Detailed view of a subject. For record subjects, the author's repo and profile will be returned.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class VideoDetails(val width: Long, val height: Long, val length: Long)