From 920da3a73f786c9aa40501926c7a1bd23b3ea06e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Wed, 9 Mar 2022 02:20:49 +0000 Subject: [PATCH] Update docs for audit logs relating to scheduled events --- docs/api.rst | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index 43da344b9..f849c72dd 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2216,6 +2216,60 @@ of :class:`enum.Enum`. .. versionadded:: 2.0 + .. attribute:: scheduled_event_create + + A scheduled event was created. + + When this is the action, the type of :attr:`~AuditLogEntry.target` is + the :class:`ScheduledEvent` or :class:`Object` with the ID of the event + which was created. + + Possible attributes for :class:`AuditLogDiff`: + - :attr:`~AuditLogDiff.name` + - :attr:`~AuditLogDiff.channel` + - :attr:`~AuditLogDiff.description` + - :attr:`~AuditLogDiff.privacy_level` + - :attr:`~AuditLogDiff.status` + - :attr:`~AuditLogDiff.entity_type` + + .. versionadded:: 2.0 + + .. attribute:: scheduled_event_update + + A scheduled event was created. + + When this is the action, the type of :attr:`~AuditLogEntry.target` is + the :class:`ScheduledEvent` or :class:`Object` with the ID of the event + which was updated. + + Possible attributes for :class:`AuditLogDiff`: + - :attr:`~AuditLogDiff.name` + - :attr:`~AuditLogDiff.channel` + - :attr:`~AuditLogDiff.description` + - :attr:`~AuditLogDiff.privacy_level` + - :attr:`~AuditLogDiff.status` + - :attr:`~AuditLogDiff.entity_type` + + .. versionadded:: 2.0 + + .. attribute:: scheduled_event_delete + + A scheduled event was created. + + When this is the action, the type of :attr:`~AuditLogEntry.target` is + the :class:`ScheduledEvent` or :class:`Object` with the ID of the event + which was deleted. + + Possible attributes for :class:`AuditLogDiff`: + - :attr:`~AuditLogDiff.name` + - :attr:`~AuditLogDiff.channel` + - :attr:`~AuditLogDiff.description` + - :attr:`~AuditLogDiff.privacy_level` + - :attr:`~AuditLogDiff.status` + - :attr:`~AuditLogDiff.entity_type` + + .. versionadded:: 2.0 + .. attribute:: thread_create A thread was created. @@ -3264,6 +3318,18 @@ AuditLogDiff :type: :class:`int` + .. attribute:: status + + The status of the scheduled event. + + :type: :class:`EventStatus` + + .. attribute:: entity_type + + The type of entity this scheduled event is for. + + :type: :class:`EntityType` + .. this is currently missing the following keys: reason and application_id I'm not sure how to about porting these