Objects¶
Action Metadata¶
action_metadata
¶
AutoModerationActionMetadataPart
¶
Base class for auto moderation action metadata parts.
AutoModerationActionMetadataSendAlertMessagePart
dataclass
¶
Bases: AutoModerationActionMetadataPart, Part
flowchart TD
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataSendAlertMessagePart[AutoModerationActionMetadataSendAlertMessagePart]
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart[AutoModerationActionMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart --> scurrypy.api.automod.action_metadata.AutoModerationActionMetadataSendAlertMessagePart
scurrypy.core.part.Part --> scurrypy.api.automod.action_metadata.AutoModerationActionMetadataSendAlertMessagePart
click scurrypy.api.automod.action_metadata.AutoModerationActionMetadataSendAlertMessagePart href "" "scurrypy.api.automod.action_metadata.AutoModerationActionMetadataSendAlertMessagePart"
click scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart href "" "scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation action metadata sending alert messages.
channel_id: RequiredPartField[Snowflake] = None
class-attribute
instance-attribute
¶
Channel ID to which user content should be logged.
AutoModerationActionMetadataTimeoutPart
dataclass
¶
Bases: AutoModerationActionMetadataPart, Part
flowchart TD
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataTimeoutPart[AutoModerationActionMetadataTimeoutPart]
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart[AutoModerationActionMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart --> scurrypy.api.automod.action_metadata.AutoModerationActionMetadataTimeoutPart
scurrypy.core.part.Part --> scurrypy.api.automod.action_metadata.AutoModerationActionMetadataTimeoutPart
click scurrypy.api.automod.action_metadata.AutoModerationActionMetadataTimeoutPart href "" "scurrypy.api.automod.action_metadata.AutoModerationActionMetadataTimeoutPart"
click scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart href "" "scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation action metadata setting timeout.
duration_seconds: RequiredPartField[int] = None
class-attribute
instance-attribute
¶
Timeout duration in seconds.
AutoModerationActionMetadataBlockMessagePart
dataclass
¶
Bases: AutoModerationActionMetadataPart, Part
flowchart TD
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataBlockMessagePart[AutoModerationActionMetadataBlockMessagePart]
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart[AutoModerationActionMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart --> scurrypy.api.automod.action_metadata.AutoModerationActionMetadataBlockMessagePart
scurrypy.core.part.Part --> scurrypy.api.automod.action_metadata.AutoModerationActionMetadataBlockMessagePart
click scurrypy.api.automod.action_metadata.AutoModerationActionMetadataBlockMessagePart href "" "scurrypy.api.automod.action_metadata.AutoModerationActionMetadataBlockMessagePart"
click scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart href "" "scurrypy.api.automod.action_metadata.AutoModerationActionMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation action metadata blocking messages.
custom_message: OptionalNullablePartField[str] = None
class-attribute
instance-attribute
¶
Additional explanation to show whenever their message is blocked.
Action¶
action
¶
AutoModerationActionPart
¶
Base class for auto moderation action parts.
AutoModerationActionSendMessageAlertPart
dataclass
¶
Bases: AutoModerationActionPart, Part
flowchart TD
scurrypy.api.automod.action.AutoModerationActionSendMessageAlertPart[AutoModerationActionSendMessageAlertPart]
scurrypy.api.automod.action.AutoModerationActionPart[AutoModerationActionPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.action.AutoModerationActionPart --> scurrypy.api.automod.action.AutoModerationActionSendMessageAlertPart
scurrypy.core.part.Part --> scurrypy.api.automod.action.AutoModerationActionSendMessageAlertPart
click scurrypy.api.automod.action.AutoModerationActionSendMessageAlertPart href "" "scurrypy.api.automod.action.AutoModerationActionSendMessageAlertPart"
click scurrypy.api.automod.action.AutoModerationActionPart href "" "scurrypy.api.automod.action.AutoModerationActionPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation action sending alert messages.
metadata: OptionalPartField[AutoModerationActionMetadataSendAlertMessagePart] = None
class-attribute
instance-attribute
¶
Additional metadata needed during execution.
type: AutoModerationActionType = field(init=False, default=(AutoModerationActionType.SEND_ALERT_MESSAGE))
class-attribute
instance-attribute
¶
Type of action. Always AutoModerationActionType.SEND_ALERT_MESSAGE for this class.
AutoModerationActionTimeoutPart
dataclass
¶
Bases: AutoModerationActionPart, Part
flowchart TD
scurrypy.api.automod.action.AutoModerationActionTimeoutPart[AutoModerationActionTimeoutPart]
scurrypy.api.automod.action.AutoModerationActionPart[AutoModerationActionPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.action.AutoModerationActionPart --> scurrypy.api.automod.action.AutoModerationActionTimeoutPart
scurrypy.core.part.Part --> scurrypy.api.automod.action.AutoModerationActionTimeoutPart
click scurrypy.api.automod.action.AutoModerationActionTimeoutPart href "" "scurrypy.api.automod.action.AutoModerationActionTimeoutPart"
click scurrypy.api.automod.action.AutoModerationActionPart href "" "scurrypy.api.automod.action.AutoModerationActionPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation action setting timeouts.
metadata: OptionalPartField[AutoModerationActionMetadataTimeoutPart] = None
class-attribute
instance-attribute
¶
Additional metadata needed during execution.
type: AutoModerationActionType = field(init=False, default=(AutoModerationActionType.TIMEOUT))
class-attribute
instance-attribute
¶
Type of action. Always AutoModerationActionType.TIMEOUT for this class.
AutoModerationActionBlockMessagePart
dataclass
¶
Bases: AutoModerationActionPart, Part
flowchart TD
scurrypy.api.automod.action.AutoModerationActionBlockMessagePart[AutoModerationActionBlockMessagePart]
scurrypy.api.automod.action.AutoModerationActionPart[AutoModerationActionPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.action.AutoModerationActionPart --> scurrypy.api.automod.action.AutoModerationActionBlockMessagePart
scurrypy.core.part.Part --> scurrypy.api.automod.action.AutoModerationActionBlockMessagePart
click scurrypy.api.automod.action.AutoModerationActionBlockMessagePart href "" "scurrypy.api.automod.action.AutoModerationActionBlockMessagePart"
click scurrypy.api.automod.action.AutoModerationActionPart href "" "scurrypy.api.automod.action.AutoModerationActionPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation action blocking messages.
metadata: OptionalPartField[AutoModerationActionMetadataBlockMessagePart] = None
class-attribute
instance-attribute
¶
Additional metadata needed during execution.
type: AutoModerationActionType = field(init=False, default=(AutoModerationActionType.BLOCK_MESSAGE))
class-attribute
instance-attribute
¶
Type of action. Always AutoModerationActionType.BLOCK_MESSAGE for this class.
Rule¶
rule
¶
AutoModerationRulePart
dataclass
¶
Bases: Part
flowchart TD
scurrypy.api.automod.rule.AutoModerationRulePart[AutoModerationRulePart]
scurrypy.core.part.Part[Part]
scurrypy.core.part.Part --> scurrypy.api.automod.rule.AutoModerationRulePart
click scurrypy.api.automod.rule.AutoModerationRulePart href "" "scurrypy.api.automod.rule.AutoModerationRulePart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation rule.
name: RequiredPartField[str] = None
class-attribute
instance-attribute
¶
Name of this rule.
event_type: RequiredPartField[AutoModerationEventType] = None
class-attribute
instance-attribute
¶
Event type of this rule.
trigger_type: RequiredPartField[AutoModerationTriggerType] = None
class-attribute
instance-attribute
¶
Trigger type of this rule.
trigger_metadata: OptionalPartField[AutoModerationTriggerMetadataPart] = None
class-attribute
instance-attribute
¶
Trigger metadata of this rule.
actions: RequiredPartField[list[AutoModerationActionPart]] = None
class-attribute
instance-attribute
¶
Actions executed when this rule is triggered.
enabled: OptionalPartField[bool] = None
class-attribute
instance-attribute
¶
Whether this rule is enabled.
exempt_roles: OptionalPartField[list[Snowflake]] = None
class-attribute
instance-attribute
¶
Role IDs that should not be affected by the rule.
exempt_channels: OptionalPartField[list[Snowflake]] = None
class-attribute
instance-attribute
¶
Channel IDs that should not be affected by the rule.
Trigger Metadata¶
trigger_metadata
¶
AutoModerationTriggerMetadataPart
¶
Base class for auto moderation trigger metadata parts.
AutoModerationTriggerMetadataKeywordPart
dataclass
¶
Bases: AutoModerationTriggerMetadataPart, Part
flowchart TD
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPart[AutoModerationTriggerMetadataKeywordPart]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart[AutoModerationTriggerMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPart
scurrypy.core.part.Part --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPart
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPart"
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation trigger metadata keyword.
keyword_filter: RequiredPartField[list[str]] = None
class-attribute
instance-attribute
¶
Substrings to be searched.
regex_patterns: RequiredPartField[list[str]] = None
class-attribute
instance-attribute
¶
Regular expression patterns to be matched against.
allow_list: RequiredPartField[list[str]] = None
class-attribute
instance-attribute
¶
Substrings which should not trigger the rule.
AutoModerationTriggerMetadataMemberProfilePart
dataclass
¶
Bases: AutoModerationTriggerMetadataPart, Part
flowchart TD
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMemberProfilePart[AutoModerationTriggerMetadataMemberProfilePart]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart[AutoModerationTriggerMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMemberProfilePart
scurrypy.core.part.Part --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMemberProfilePart
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMemberProfilePart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMemberProfilePart"
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation trigger metadata member profile.
keyword_filter: RequiredPartField[list[str]] = None
class-attribute
instance-attribute
¶
Substrings to be searched.
regex_patterns: RequiredPartField[list[str]] = None
class-attribute
instance-attribute
¶
Regular expression patterns to be matched against.
allow_list: RequiredPartField[list[str]] = None
class-attribute
instance-attribute
¶
Substrings which should not trigger the rule.
AutoModerationTriggerMetadataKeywordPresetPart
dataclass
¶
Bases: AutoModerationTriggerMetadataPart, Part
flowchart TD
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPresetPart[AutoModerationTriggerMetadataKeywordPresetPart]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart[AutoModerationTriggerMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPresetPart
scurrypy.core.part.Part --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPresetPart
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPresetPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataKeywordPresetPart"
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation trigger metadata keyword preset.
AutoModerationTriggerMetadataMentionSpamPart
dataclass
¶
Bases: AutoModerationTriggerMetadataPart, Part
flowchart TD
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMentionSpamPart[AutoModerationTriggerMetadataMentionSpamPart]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart[AutoModerationTriggerMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMentionSpamPart
scurrypy.core.part.Part --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMentionSpamPart
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMentionSpamPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataMentionSpamPart"
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation trigger metadata mention spam.
mention_total_limit: RequiredPartField[int] = None
class-attribute
instance-attribute
¶
Total number of unique role and user mentions allowed per message.
mention_raid_protection_enabled: RequiredPartField[bool] = None
class-attribute
instance-attribute
¶
Whether to automatically detect mention raids.
AutoModerationTriggerMetadataSpamPart
dataclass
¶
Bases: AutoModerationTriggerMetadataPart, Part
flowchart TD
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataSpamPart[AutoModerationTriggerMetadataSpamPart]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart[AutoModerationTriggerMetadataPart]
scurrypy.core.part.Part[Part]
scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataSpamPart
scurrypy.core.part.Part --> scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataSpamPart
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataSpamPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataSpamPart"
click scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart href "" "scurrypy.api.automod.trigger_metadata.AutoModerationTriggerMetadataPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an auto moderation trigger metadata spam.