feat: Add support for Guild Scheduled Event Recurrence

CHANGELOG.md

@@ -12,6 +12,9 @@ These changes are available on the `master` branch, but have not yet been releas
 
 ### Added
 
+- Added support getting and setting recurrence rules on `ScheduledEvent`s.
+  ([#2749](https://github.com/Pycord-Development/pycord/pull/2749))
+
 ### Changed
 
 ### Fixed

discord/enums.py

@@ -83,6 +83,8 @@
     "ThreadArchiveDuration",
     "SubscriptionStatus",
     "SeparatorSpacingSize",
+    "ScheduledEventRecurrenceFrequency",
+    "ScheduledEventWeekday",
     "SelectDefaultValueType",
 )
 
@@ -1104,6 +1106,27 @@ class SubscriptionStatus(Enum):
     inactive = 2
 
 
+class ScheduledEventRecurrenceFrequency(Enum):
+    """A scheduled event recurrence rule's frequency."""
+
+    yearly = 0
+    monthly = 1
+    weekly = 2
+    daily = 3
+
+
+class ScheduledEventWeekday(Enum):
+    """A scheduled event week day."""
+
+    monday = 0
+    tuesday = 1
+    wednesday = 2
+    thursday = 3
+    friday = 4
+    saturday = 5
+    sunday = 6
+
+
 class ThreadArchiveDuration(IntEnum):
     """The time set until a thread is automatically archived."""
 

discord/guild.py

@@ -84,7 +84,11 @@
 from .onboarding import Onboarding
 from .permissions import PermissionOverwrite
 from .role import Role, RoleColours
-from .scheduled_events import ScheduledEvent, ScheduledEventLocation
+from .scheduled_events import (
+    ScheduledEvent,
+    ScheduledEventLocation,
+    ScheduledEventRecurrenceRule,
+)
 from .soundboard import SoundboardSound
 from .stage_instance import StageInstance
 from .sticker import GuildSticker
@@ -4219,8 +4223,10 @@ async def create_scheduled_event(
         privacy_level: ScheduledEventPrivacyLevel = ScheduledEventPrivacyLevel.guild_only,
         reason: str | None = None,
         image: bytes = MISSING,
-    ) -> ScheduledEvent | None:
+        recurrence_rule: ScheduledEventRecurrenceRule | None = MISSING,
+    ) -> ScheduledEvent:
         """|coro|
+
         Creates a scheduled event.
 
         Parameters
@@ -4242,7 +4248,10 @@ async def create_scheduled_event(
         reason: Optional[:class:`str`]
             The reason to show in the audit log.
         image: Optional[:class:`bytes`]
-            The cover image of the scheduled event
+            The cover image of the scheduled event.
+        recurrence_rule: Optional[:class:`ScheduledEventRecurrenceRule`]
+            The recurrence rule this event will follow. If this is ``None`` then this is a
+            one-time event.
 
         Returns
         -------
@@ -4256,7 +4265,8 @@ async def create_scheduled_event(
         HTTPException
             The operation failed.
         """
-        payload: dict[str, str | int] = {
+
+        payload: dict[str, Any] = {
             "name": name,
             "scheduled_start_time": start_time.isoformat(),
             "privacy_level": int(privacy_level),
@@ -4283,6 +4293,12 @@ async def create_scheduled_event(
         if image is not MISSING:
             payload["image"] = utils._bytes_to_base64_data(image)
 
+        if recurrence_rule is not MISSING:
+            if recurrence_rule is None:
+                payload["recurrence_rule"] = None
+            else:
+                payload["recurrence_rule"] = recurrence_rule._to_dict()
+
         data = await self._state.http.create_scheduled_event(
             guild_id=self.id, reason=reason, **payload
         )