Introducing auto moderation

src/main/java/net/dv8tion/jda/api/audit/ActionType.java

@@ -532,6 +532,71 @@ public enum ActionType
      */
     THREAD_DELETE(112, TargetType.THREAD),
 
+    /**
+     * A user created a {@link net.dv8tion.jda.api.entities.AutoModerationRule auto-moderation rule}
+     *
+     * <h4>Possible Keys</h4>
+     * <ul>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#ID ID}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_GUILD_ID GUILD}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_RULE_NAME RULE_NAME}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_CREATOR CREATOR}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EVENT_TYPE EVENT_TYPE}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_TRIGGER_TYPE TRIGGER_TYPE}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_TRIGGER_METADATA METADETA}</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_ACTIONS}&gt;</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_ENABLED ENABLED}</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EXEMPT_ROLES}&gt;</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EXEMPT_CHANNELS}&gt;</li>
+     * </ul>
+     */
+    AUTO_MODERATION_RULE_CREATE(140, TargetType.AUTO_MODERATION_RULE),
+
+    /**
+     * A user updated a {@link net.dv8tion.jda.api.entities.AutoModerationRule auto-moderation rule}
+     *
+     * <h4>Possible Keys</h4>
+     * <ul>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#ID ID}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_GUILD_ID GUILD}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_RULE_NAME RULE_NAME}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_CREATOR CREATOR}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EVENT_TYPE EVENT_TYPE}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_TRIGGER_TYPE TRIGGER_TYPE}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_TRIGGER_METADATA METADETA}</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_ACTIONS}&gt;</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_ENABLED ENABLED}</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EXEMPT_ROLES}&gt;</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EXEMPT_CHANNELS}&gt;</li>
+     * </ul>
+     */
+    AUTO_MODERATION_RULE_UPDATE(141, TargetType.AUTO_MODERATION_RULE),
+
+    /**
+     * A user deleted a {@link net.dv8tion.jda.api.entities.AutoModerationRule auto-moderation rule}
+     *
+     * <h4>Possible Keys</h4>
+     * <ul>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#ID ID}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_GUILD_ID GUILD}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_RULE_NAME RULE_NAME}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_CREATOR CREATOR}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EVENT_TYPE EVENT_TYPE}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_TRIGGER_TYPE TRIGGER_TYPE}</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_TRIGGER_METADATA METADETA}</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_ACTIONS}&gt;</li>
+     *     <li>{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_ENABLED ENABLED}</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EXEMPT_ROLES}&gt;</li>
+     *     <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.audit.AuditLogKey#AUTO_MODERATION_EXEMPT_CHANNELS}&gt;</li>
+     * </ul>
+     */
+    AUTO_MODERATION_RULE_DELETE(142, TargetType.AUTO_MODERATION_RULE),
+
+    /**
+     * When a message is blocked by the {@link net.dv8tion.jda.api.entities.AutoModerationRule auto-moderation rule}
+     */
+    AUTO_MODERATION_BLOCK_MESSAGE(143, TargetType.AUTO_MODERATION_RULE),
+
     UNKNOWN(-1, TargetType.UNKNOWN);
 
     private final int key;

src/main/java/net/dv8tion/jda/api/audit/AuditLogKey.java

@@ -559,8 +559,85 @@ public enum AuditLogKey
      *
      * <p>Expected type: <b>int</b>
      */
-    INVITE_MAX_USES("max_uses");
+    INVITE_MAX_USES("max_uses"),
 
+    /**
+     * The guild where the auto moderation rule was created in.
+     *
+     * <p>Expected type: <b>String</b>
+     */
+    AUTO_MODERATION_GUILD_ID("guild_id"),
+
+    /**
+     * The name of the rule which was created/updated/deleted.
+     *
+     * <p>Expected type: <b>String</b>
+     */
+    AUTO_MODERATION_RULE_NAME("name"),
+
+    /**
+     * The name of the user who created/updated/deleted the rule.
+     *
+     * <p>Expected type: <b>String</b>
+     */
+    AUTO_MODERATION_CREATOR("user"),
+
+    /**
+     * The event will cause the auto-moderation system to check for a specific trigger.
+     *
+     * <p>Expected type: <b>Integer</b>
+     */
+    AUTO_MODERATION_EVENT_TYPE("event_type"),
+
+    /**
+     * What caused the auto moderation system to be triggered.
+     *
+     * <p>Expected type: <b>Integer</b>
+     */
+    AUTO_MODERATION_TRIGGER_TYPE("trigger_type"),
+
+    /**
+     * This is additional data used whether a rule should be executed or not.
+     *
+     * <p>Expected types:
+     * <ul>
+     *      <li>{@link java.util.List}&lt;{@link java.lang.String}&gt;</li>
+     *      <li>{@link java.util.List}&lt;{@link net.dv8tion.jda.api.entities.KeywordPresetType}&gt;</li>
+     * </ul>
+     */
+    AUTO_MODERATION_TRIGGER_METADATA("trigger_metadata"),
+
+    /**
+     * The actions which will carried out when the rule is triggered.
+     *
+     * <p>Expected types:
+     * <ul>
+     *     <li>{@link net.dv8tion.jda.api.entities.ActionType}</li>
+     *     <li>{@link net.dv8tion.jda.api.entities.ActionMetadata}</li>
+     * </ul>
+     */
+    AUTO_MODERATION_ACTIONS("actions"),
+
+    /**
+     * Weather this rule is enabled or not.
+     *
+     * <p>Expected type: <b>boolean</b>
+     */
+    AUTO_MODERATION_ENABLED("enabled"),
+
+    /**
+     * The role which is exempt from the rules
+     *
+     * <p>Expected type: <b>String</b>
+     */
+    AUTO_MODERATION_EXEMPT_ROLES("exempt_roles"),
+
+    /**
+     * The channel which is exempt from the rules
+     *
+     * <p>Expected type: <b>String</b>
+     */
+    AUTO_MODERATION_EXEMPT_CHANNELS("exempt_channels");
 
     private final String key;
 

src/main/java/net/dv8tion/jda/api/audit/TargetType.java

@@ -41,5 +41,6 @@ public enum TargetType
     INTEGRATION,
     STAGE_INSTANCE,
     THREAD,
+    AUTO_MODERATION_RULE,
     UNKNOWN
 }

src/main/java/net/dv8tion/jda/api/entities/ActionMetadata.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.dv8tion.jda.api.entities;
+
+/**
+ * This is additional data which is used when an action is executed by the auto-moderation system.
+ *
+ * <br>
+ * Different values depend on the {@link ActionType ActionType} of the action.
+ */
+public interface ActionMetadata {
+    /**
+     * The channel where the logging of the auto-moderation rule breaking should be sent to.
+     *
+     * @return {@link net.dv8tion.jda.api.entities.TextChannel TextChannel}
+     */
+    TextChannel getChannel();
+
+    /**
+     * The duration of the timeout in seconds.
+     *
+     * @return {@link java.lang.Integer Integer}
+     */
+    int getDuration();
+}

src/main/java/net/dv8tion/jda/api/entities/ActionType.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.dv8tion.jda.api.entities;
+
+/**
+ * Represents the type of action that was performed when a one rules set in the auto-moderation system was broken.
+ */
+public enum ActionType
+{
+    /**
+     * Blocks the message if the message breaks the auto-moderation rules.
+     */
+    BLOCK_MESSAGE(1),
+    /**
+     * Sends an alert to a specific channel if a member breaks the auto-moderation rules.
+     */
+    SEND_ALERT_MESSAGE(2),
+    /**
+     * Times out the member who broke the auto-moderation rules.
+     */
+    TIMEOUT(3),
+    /**
+     * An unknown action type.
+     */
+    UNKNOWN(-1);
+
+    private final int value;
+
+    ActionType(int value) {
+        this.value = value;
+    }
+
+    public int getValue() {
+        return value;
+    }
+
+    public static ActionType fromValue(int value) {
+        for (ActionType type : values()) {
+            if (type.value == value) {
+                return type;
+            }
+        }
+        return UNKNOWN;
+    }
+}

src/main/java/net/dv8tion/jda/api/entities/AutoModerationAction.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.dv8tion.jda.api.entities;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/**
+ * This is the action which will be executed by the auto-moderation system when a rule is triggered.
+ */
+public interface AutoModerationAction {
+    /**
+     * Gets the action type.
+     *
+     * @return {@link ActionType ActionTypes}
+     */
+    @Nonnull
+    ActionType getActionType();
+
+    /**
+     * Additional metadata needed during the execution for this specific action type
+     *
+     * @return {@link ActionMetadata ActionMetadata}
+     */
+    @Nullable
+    ActionMetadata getActionMetadata();
+}