Skip to content

Make the Audit Log Change Key typed and add constants for its possible values #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Make the Audit Log Change Key typed and add constants for its possible values #377

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c8e528
fix: make AuditLogChange.Key typed with constants instead of just a s…
myrkvi Aug 12, 2024
1658a3f
chore: move type declaration to immediately before related definitions.
myrkvi Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 100 additions & 1 deletion discord/audit_log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,105 @@ const (
AuditLogHomeSettingsUpdate
)

// AuditLogChangeKey is a string representing a key in the audit log change object.
type AuditLogChangeKey string

const (
AuditLogChangeKeyAFKChannelID AuditLogChangeKey = "afk_channel_id"
AuditLogChangeKeyAFKTimeout AuditLogChangeKey = "afk_timeout"
// AuditLogChangeKeyAllow is sent when a role's permission overwrites changed (stringy int)
AuditLogChangeKeyAllow AuditLogChangeKey = "allow"
AuditLogChangeKeyApplicationID AuditLogChangeKey = "application_id"
// AuditLogChangeKeyArchived is sent when a channel thread is archived/unarchived (bool)
AuditLogChangeKeyArchived AuditLogChangeKey = "archived"
AuditLogChangeKeyAsset AuditLogChangeKey = "asset"
// AuditLogChangeKeyAutoArchiveDuration is sent when a thread's auto archive duration is changed (int)
AuditLogChangeKeyAutoArchiveDuration AuditLogChangeKey = "auto_archive_duration"
AuditLogChangeKeyAvailable AuditLogChangeKey = "available"
AuditLogChangeKeyAvatarHash AuditLogChangeKey = "avatar_hash"
AuditLogChangeKeyBannerHash AuditLogChangeKey = "banner_hash"
AuditLogChangeKeyBitrate AuditLogChangeKey = "bitrate"
AuditLogChangeKeyChannelID AuditLogChangeKey = "channel_id"
AuditLogChangeKeyCode AuditLogChangeKey = "code"
// AuditLogChangeKeyColor is sent when a role's color is changed (int)
AuditLogChangeKeyColor AuditLogChangeKey = "color"
// AuditLogChangeKeyCommunicationDisabledUntil is sent when a user's communication disabled until datetime is changed (stringy ISO8601 datetime)
AuditLogChangeKeyCommunicationDisabledUntil AuditLogChangeKey = "communication_disabled_until"
// AuditLogChangeKeyDeaf is sent when a user is set to be server deafened/undeafened (bool)
AuditLogChangeKeyDeaf AuditLogChangeKey = "deaf"
AuditLogChangeKeyDefaultAutoArchiveDuration AuditLogChangeKey = "default_auto_archive_duration"
AuditLogChangeKeyDefaultMessageNotifications AuditLogChangeKey = "default_message_notifications"
// AuditLogChangeKeyDeny is sent when a role's permission overwrites changed (stringed int)
AuditLogChangeKeyDeny AuditLogChangeKey = "deny"
AuditLogChangeKeyDescription AuditLogChangeKey = "description"
AuditLogChangeKeyDiscoverySplashHash AuditLogChangeKey = "discovery_splash_hash"
AuditLogChangeKeyEnableEmoticons AuditLogChangeKey = "enable_emoticons"
AuditLogChangeKeyEntityType AuditLogChangeKey = "entity_type"
AuditLogChangeKeyExpireBehavior AuditLogChangeKey = "expire_behavior"
AuditLogChangeKeyExpireGracePeriod AuditLogChangeKey = "expire_grace_period"
AuditLogChangeKeyExplicitContentFilter AuditLogChangeKey = "explicit_content_filter"
AuditLogChangeKeyFormatType AuditLogChangeKey = "format_type"
AuditLogChangeKeyGuildID AuditLogChangeKey = "guild_id"
// AuditLogChangeKeyHoist is sent when a role is set to be displayed separately from online members (bool)
AuditLogChangeKeyHoist AuditLogChangeKey = "hoist"
AuditLogChangeKeyIconHash AuditLogChangeKey = "icon_hash"
AuditLogChangeKeyID AuditLogChangeKey = "id"
AuditLogChangeKeyInvitable AuditLogChangeKey = "invitable"
AuditLogChangeKeyInviterID AuditLogChangeKey = "inviter_id"
AuditLogChangeKeyLocation AuditLogChangeKey = "location"
// AuditLogChangeKeyLocked is sent when a channel thread is locked/unlocked (bool)
AuditLogChangeKeyLocked AuditLogChangeKey = "locked"
AuditLogChangeKeyMaxAge AuditLogChangeKey = "max_age"
AuditLogChangeKeyMaxUses AuditLogChangeKey = "max_uses"
// AuditLogChangeKeyMentionable is sent when a role changes its mentionable state (bool)
AuditLogChangeKeyMentionable AuditLogChangeKey = "mentionable"
AuditLogChangeKeyMFALevel AuditLogChangeKey = "mfa_level"
// AuditLogChangeKeyMute is sent when a user is server muted/unmuted (bool)
AuditLogChangeKeyMute AuditLogChangeKey = "mute"
AuditLogChangeKeyName AuditLogChangeKey = "name"
// AuditLogChangeKeyNick is sent when a user's nickname is changed (string)
AuditLogChangeKeyNick AuditLogChangeKey = "nick"
AuditLogChangeKeyNSFW AuditLogChangeKey = "nsfw"
// AuditLogChangeKeyOwnerID is sent when owner id of a guild changed (snowflake.ID)
AuditLogChangeKeyOwnerID AuditLogChangeKey = "owner_id"
// AuditLogChangeKeyPermissionOverwrites is sent when a role's permission overwrites changed (string)
AuditLogChangeKeyPermissionOverwrites AuditLogChangeKey = "permission_overwrites"
// AuditLogChangeKeyPermissions is sent when a role's permissions changed (string)
AuditLogChangeKeyPermissions AuditLogChangeKey = "permissions"
// AuditLogChangeKeyPosition is sent when channel position changed (int)
AuditLogChangeKeyPosition AuditLogChangeKey = "position"
AuditLogChangeKeyPreferredLocale AuditLogChangeKey = "preferred_locale"
AuditLogChangeKeyPrivacyLevel AuditLogChangeKey = "privacy_level"
AuditLogChangeKeyPruneDeleteDays AuditLogChangeKey = "prune_delete_days"
AuditLogChangeKeyPublicUpdatesChannelID AuditLogChangeKey = "public_updates_channel_id"
AuditLogChangeKeyRateLimitPerUser AuditLogChangeKey = "rate_limit_per_user"
AuditLogChangeKeyRegion AuditLogChangeKey = "region"
AuditLogChangeKeyRulesChannelID AuditLogChangeKey = "rules_channel_id"
AuditLogChangeKeySplashHash AuditLogChangeKey = "splash_hash"
AuditLogChangeKeyStatus AuditLogChangeKey = "status"
// AuditLogChangeKeySystemChannelID is sent when system channel id of a guild changed (snowflake.ID)
AuditLogChangeKeySystemChannelID AuditLogChangeKey = "system_channel_id"
AuditLogChangeKeyTags AuditLogChangeKey = "tags"
AuditLogChangeKeyTemporary AuditLogChangeKey = "temporary"
// AuditLogChangeKeyTopic is sent when channel topic changed (string)
AuditLogChangeKeyTopic AuditLogChangeKey = "topic"
AuditLogChangeKeyType AuditLogChangeKey = "type"
AuditLogChangeKeyUnicodeEmoji AuditLogChangeKey = "unicode_emoji"
// AuditLogChangeKeyUserLimit is sent when user limit of a voice channel changed (int)
AuditLogChangeKeyUserLimit AuditLogChangeKey = "user_limit"
AuditLogChangeKeyUses AuditLogChangeKey = "uses"
AuditLogChangeKeyVanityURLCode AuditLogChangeKey = "vanity_url_code"
// AuditLogChangeKeyVerificationLevel is sent when verification level of the server changed (int)
AuditLogChangeKeyVerificationLevel AuditLogChangeKey = "verification_level"
AuditLogChangeKeyWidgetChannelID AuditLogChangeKey = "widget_channel_id"
// AuditLogChangeKeyWidgetEnabled is sent when a server widget is enabled/disabled (bool)
AuditLogChangeKeyWidgetEnabled AuditLogChangeKey = "widget_enabled"
// AuditLogChangeKeyRoleAdd is sent when roles are added to a user (array of discord.PartialRole JSON)
AuditLogChangeKeyRoleAdd AuditLogChangeKey = "$add"
// AuditLogChangeKeyRoleRemove is sent when roles are removed from a user (array of discord.PartialRole JSON)
AuditLogChangeKeyRoleRemove AuditLogChangeKey = "$remove"
)

// AuditLog (https://discord.com/developers/docs/resources/audit-log) These are logs of events that occurred, accessible via the Discord
type AuditLog struct {
ApplicationCommands []ApplicationCommand `json:"application_commands"`
Expand Down Expand Up @@ -190,7 +289,7 @@ type AuditLogChange struct {
// OldValue is the old value of the key before the change as a json.RawMessage.
OldValue json.RawMessage `json:"old_value"`
// Key is the key of the change.
Key string `json:"key"`
Key AuditLogChangeKey `json:"key"`
}

// UnmarshalNewValue unmarshals the NewValue field into the provided type.
Expand Down