diff --git a/content/en/entities/AccountWarning.md b/content/en/entities/AccountWarning.md new file mode 100644 index 00000000..4ede0d9e --- /dev/null +++ b/content/en/entities/AccountWarning.md @@ -0,0 +1,69 @@ +--- +title: AccountWarning +description: Moderation warning against a particular account. +menu: + docs: + parent: entities +aliases: [ + "/entities/AccountWarning", + "/api/entities/AccountWarning", +] +--- + +## Attributes + +### `id` {#id} + +**Description:** The ID of the account warning in the database.\ +**Type:** String (cast from integer)\ +**Version history:**\ +4.3.0 - added + +### `action` {#action} + +**Description:** Action taken against the account.\ +**Type:** String (Enumerable oneOf)\ +`none` = No action was taken, this is a simple warning\ +`disable` = The account has been disabled\ +`mark_statuses_as_sensitive` = Specific posts from the target account have been marked as sensitive\ +`delete_statuses` = Specific statuses from the target account have been deleted\ +`sensitive` = All posts from the target account are marked as sensitive\ +`silence` = The target account has been limited\ +`suspend` = The target account has been suspended\ +**Version history:**\ +4.3.0 - added + +### `text` {#text} + +**Description:** Message from the moderator to the target account.\ +**Type:** String\ +**Version history:**\ +4.3.0 - added + +### `status_ids` {#status_ids} + +**Description:** List of status IDs that are relevant to the warning. When `action` is `mark_statuses_as_sensitive` or `delete_statuses`, those are the affected statuses.\ +**Type:** Array of String (cast from integer)\ +**Version history:**\ +4.3.0 - added + +### `target_account` {#target_account} + +**Description:** Account against which a moderation decision has been taken.\ +**Type:** [Account]({{< relref "entities/Account" >}})\ +**Version history:**\ +4.3.0 - added + +### `appeal` {#appeal} + +**Description:** Appeal submitted by the target account, if any.\ +**Type:** {{}} [Appeal]({{< relref "entities/Appeal" >}}), or null\ +**Version history:**\ +4.3.0 - added + +### `created_at` {#created_at} + +**Description:** When the event took place.\ +**Type:** String (ISO 8601 Datetime)\ +**Version history:**\ +4.3.0 - added diff --git a/content/en/entities/Appeal.md b/content/en/entities/Appeal.md new file mode 100644 index 00000000..a14866d6 --- /dev/null +++ b/content/en/entities/Appeal.md @@ -0,0 +1,30 @@ +--- +title: Appeal +description: Appeal against a moderation action. +menu: + docs: + parent: entities +aliases: [ + "/entities/Appeal", + "/api/entities/Appeal", +] +--- + +## Attributes + +### `text` {#text} + +**Description:** Text of the appeal from the moderated account to the moderators.\ +**Type:** String\ +**Version history:**\ +4.3.0 - added + +### `state` {#state} + +**Description:** State of the appeal.\ +**Type:** String (Enumerable oneOf)\ +`approved` = The appeal has been approved by a moderator\ +`rejected` = The appeal has been rejected by a moderator\ +`pending` = The appeal has been submitted, but neither approved nor rejected yet\ +**Version history:**\ +4.3.0 - added diff --git a/content/en/entities/Notification.md b/content/en/entities/Notification.md index 568cc46f..6ee9b22b 100644 --- a/content/en/entities/Notification.md +++ b/content/en/entities/Notification.md @@ -36,6 +36,7 @@ aliases: [ `admin.sign_up` = Someone signed up (optionally sent to admins)\ `admin.report` = A new report has been filed\ `severed_relationships` = Some of your follow relationships have been severed as a result of a moderation or block event\ +`moderation_warning` = A moderator has taken action against your account or has sent you a warning\ **Version history:**\ 0.9.9 - added\ 2.8.0 - added `poll`\ @@ -43,7 +44,7 @@ aliases: [ 3.3.0 - added `status`\ 3.5.0 - added `update` and `admin.sign_up`\ 4.0.0 - added `admin.report`\ -4.3.0 - added `severed_relationships` +4.3.0 - added `severed_relationships` and `moderation_warning` ### `created_at` {#created_at} @@ -80,6 +81,13 @@ aliases: [ **Version history:**\ 4.3.0 - added +### `moderation_warning` {{%optional%}} {#moderation_warning} + +**Description:** Moderation warning that caused the notification. Attached when `type` of the notification is `moderation_warning`.\ +**Type:** [AccountWarning]({{< relref "entities/AccountWarning" >}})\ +**Version history:**\ +4.3.0 - added + ## Examples ### Mention