feat(Onboarding): add edit method

changelog/1011.feature.rst

@@ -0,0 +1,4 @@
+Allow editing Onboarding configurations.
+    - :class:`OnboardingPrompt` and :class:`OnboardingPromptOption` are now user-constructible.
+    - Add :meth:`Guild.edit_onboarding`.
+    - Add :attr:`Onboarding.mode`.

disnake/enums.py

@@ -68,6 +68,7 @@
     "Event",
     "ApplicationRoleConnectionMetadataType",
     "OnboardingPromptType",
+    "OnboardingMode",
     "SKUType",
     "EntitlementType",
 )
@@ -1335,6 +1336,11 @@ class OnboardingPromptType(Enum):
     dropdown = 1
 
 
+class OnboardingMode(Enum):
+    default = 0
+    advanced = 1
+
+
 class SKUType(Enum):
     subscription = 5
     subscription_group = 6

disnake/guild.py

@@ -52,6 +52,7 @@
     Locale,
     NotificationLevel,
     NSFWLevel,
+    OnboardingMode,
     ThreadLayout,
     ThreadSortOrder,
     VerificationLevel,
@@ -95,6 +96,7 @@
     from .app_commands import APIApplicationCommand
     from .asset import AssetBytes
     from .automod import AutoModTriggerMetadata
+    from .onboarding import OnboardingPrompt
     from .permissions import Permissions
     from .state import ConnectionState
     from .template import Template
@@ -109,6 +111,7 @@
         MFALevel,
     )
     from .types.integration import IntegrationType
+    from .types.onboarding import EditOnboarding as EditOnboardingPayload
     from .types.role import CreateRole as CreateRolePayload
     from .types.sticker import CreateGuildSticker as CreateStickerPayload
     from .types.threads import Thread as ThreadPayload, ThreadArchiveDurationLiteral
@@ -3700,7 +3703,7 @@ async def create_role(
 
         Creates a :class:`Role` for the guild.
 
-        All fields are optional.
+        All parameters are optional.
 
         You must have :attr:`~Permissions.manage_roles` permission to
         do this.
@@ -4955,6 +4958,71 @@ async def onboarding(self) -> Onboarding:
         data = await self._state.http.get_guild_onboarding(self.id)
         return Onboarding(data=data, guild=self)
 
+    async def edit_onboarding(
+        self,
+        *,
+        prompts: List[OnboardingPrompt] = MISSING,
+        default_channels: Iterable[Snowflake] = MISSING,
+        enabled: bool = MISSING,
+        mode: OnboardingMode = MISSING,
+        reason: Optional[str] = None,
+    ) -> Onboarding:
+        """|coro|
+
+        Edits the guild onboarding.
+
+        You must have :attr:`.Permissions.manage_guild` and :attr:`.Permissions.manage_roles`
+        permissions to do this.
+
+        All parameters are optional.
+
+        .. versionadded:: 2.10
+
+        Parameters
+        ----------
+        prompts: List[:class:`OnboardingPrompt`]
+            The onboarding's new prompts.
+        default_channels: Iterable[:class:`abc.Snowflake`]
+            The onboarding's new default channels.
+        enabled: :class:`bool`
+            Whether the onboarding is enabled.
+        mode: :class:`OnboardingMode`
+            The onboarding's new mode. This defines the criteria used to satisfy Onboarding
+            constraints that are required for enabling it.
+        reason: Optional[:class:`str`]
+            The reason for editing the guild onboarding. Shows up on the audit log.
+
+        Raises
+        ------
+        HTTPException
+            Editing the guild onboarding failed.
+
+        Returns
+        -------
+        :class:`Onboarding`
+            The newly edited guild onboarding.
+        """
+        edit_payload: EditOnboardingPayload = {}
+
+        if prompts is not MISSING:
+            edit_payload["prompts"] = [p.to_dict() for p in prompts]
+
+        if default_channels is not MISSING:
+            edit_payload["default_channel_ids"] = [c.id for c in default_channels]
+
+        if enabled is not MISSING:
+            edit_payload["enabled"] = enabled
+
+        if mode is not MISSING:
+            edit_payload["mode"] = mode.value
+
+        data = await self._state.http.edit_guild_onboarding(
+            self.id,
+            **edit_payload,
+            reason=reason,
+        )
+        return Onboarding(data=data, guild=self)
+
 
 PlaceholderID = NewType("PlaceholderID", int)
 

disnake/http.py

@@ -2289,6 +2289,22 @@ def delete_auto_moderation_rule(
     def get_guild_onboarding(self, guild_id: Snowflake) -> Response[onboarding.Onboarding]:
         return self.request(Route("GET", "/guilds/{guild_id}/onboarding", guild_id=guild_id))
 
+    def edit_guild_onboarding(
+        self,
+        guild_id: Snowflake,
+        *,
+        reason: Optional[str] = None,
+        **fields: Any,
+    ) -> Response[onboarding.Onboarding]:
+        valid_keys = ("prompts", "default_channels_ids", "enabled", "mode")
+        payload = {k: v for k, v in fields.items() if k in valid_keys}
+
+        return self.request(
+            Route("PUT", "/guilds/{guild_id}/onboarding", guild_id=guild_id),
+            json=payload,
+            reason=reason,
+        )
+
     # SKUs/Entitlements
 
     def get_skus(self, application_id: Snowflake) -> Response[List[sku.SKU]]: