Add update onboarding endpoint to GuildManager

lib/nyxx.dart

@@ -58,6 +58,7 @@ export 'src/builders/guild/scheduled_event.dart' show ScheduledEventBuilder, Sch
 export 'src/builders/guild/template.dart' show GuildTemplateBuilder, GuildTemplateUpdateBuilder;
 export 'src/builders/guild/auto_moderation.dart'
     show AutoModerationRuleBuilder, AutoModerationRuleUpdateBuilder, ActionMetadataBuilder, AutoModerationActionBuilder;
+export 'src/builders/guild/onboarding.dart' show OnboardingPromptBuilder, OnboardingPromptOptionBuilder, OnboardingUpdateBuilder;
 export 'src/builders/role.dart' show RoleBuilder, RoleUpdateBuilder;
 export 'src/builders/voice.dart' show CurrentUserVoiceStateUpdateBuilder, VoiceStateUpdateBuilder, GatewayVoiceStateBuilder;
 export 'src/builders/presence.dart' show PresenceBuilder, CurrentUserStatus, ActivityBuilder;
@@ -185,7 +186,7 @@ export 'src/models/guild/guild.dart'
         UserGuild;
 export 'src/models/guild/integration.dart' show PartialIntegration, Integration, IntegrationAccount, IntegrationApplication, IntegrationExpireBehavior;
 export 'src/models/guild/member.dart' show Member, MemberFlags, PartialMember;
-export 'src/models/guild/onboarding.dart' show Onboarding, OnboardingPrompt, OnboardingPromptOption, OnboardingPromptType;
+export 'src/models/guild/onboarding.dart' show Onboarding, OnboardingPrompt, OnboardingPromptOption, OnboardingPromptType, OnboardingMode;
 export 'src/models/guild/welcome_screen.dart' show WelcomeScreen, WelcomeScreenChannel;
 export 'src/models/guild/scheduled_event.dart' show EntityMetadata, PartialScheduledEvent, ScheduledEvent, ScheduledEventUser, EventStatus, ScheduledEntityType;
 export 'src/models/guild/audit_log.dart' show AuditLogChange, AuditLogEntry, AuditLogEntryInfo, PartialAuditLogEntry, AuditLogEvent;

lib/src/builders/guild/onboarding.dart

@@ -0,0 +1,95 @@
+import 'package:nyxx/src/builders/builder.dart';
+import 'package:nyxx/src/models/emoji.dart';
+import 'package:nyxx/src/models/guild/onboarding.dart';
+import 'package:nyxx/src/models/snowflake.dart';
+
+class OnboardingUpdateBuilder extends UpdateBuilder<Onboarding> {
+  List<OnboardingPromptBuilder> prompts;
+
+  List<Snowflake> defaultChannelIds;
+
+  bool isEnabled;
+
+  OnboardingMode mode;
+
+  OnboardingUpdateBuilder({
+    required this.prompts,
+    required this.defaultChannelIds,
+    required this.isEnabled,
+    required this.mode,
+  });
+
+  @override
+  Map<String, Object?> build() => {
+        'prompts': prompts.map((prompt) => prompt.build()).toList(),
+        'default_channel_ids': defaultChannelIds.map((channelId) => channelId.toString()).toList(),
+        'enabled': isEnabled,
+        'mode': mode.value,
+      };
+}
+
+class OnboardingPromptBuilder extends CreateBuilder<OnboardingPrompt> {
+  OnboardingPromptType type;
+
+  List<OnboardingPromptOptionBuilder> options;
+
+  String title;
+
+  bool isSingleSelect;
+
+  bool isRequired;
+
+  bool isInOnboarding;
+
+  OnboardingPromptBuilder({
+    required this.type,
+    required this.options,
+    required this.title,
+    required this.isSingleSelect,
+    required this.isRequired,
+    required this.isInOnboarding,
+  });
+
+  @override
+  Map<String, Object?> build() => {
+        'type': type.value,
+        'options': options.map((option) => option.build()).toList(),
+        'title': title,
+        'single_select': isSingleSelect,
+        'required': isRequired,
+        'in_onboarding': isInOnboarding,
+      };
+}
+
+class OnboardingPromptOptionBuilder extends CreateBuilder<OnboardingPromptOption> {
+  List<Snowflake> channelIds;
+
+  List<Snowflake> roleIds;
+
+  Emoji? emoji;
+
+  String title;
+
+  String? description;
+
+  OnboardingPromptOptionBuilder({
+    required this.channelIds,
+    required this.roleIds,
+    this.emoji,
+    required this.title,
+    this.description,
+  });
+
+  @override
+  Map<String, Object?> build() => {
+        'channel_ids': channelIds.map((id) => id.toString()).toList(),
+        'role_ids': roleIds.map((id) => id.toString()).toList(),
+        if (emoji case final emoji?) 'emoji_name': emoji.name,
+        if (emoji case GuildEmoji emoji) ...{
+          'emoji_id': emoji.id,
+          'emoji_animated': emoji.isAnimated,
+        },
+        'title': title,
+        'description': description,
+      };
+}

lib/src/http/managers/guild_manager.dart

@@ -4,6 +4,7 @@ import 'dart:typed_data';
 import 'package:nyxx/src/builders/channel/channel_position.dart';
 import 'package:nyxx/src/builders/channel/guild_channel.dart';
 import 'package:nyxx/src/builders/guild/guild.dart';
+import 'package:nyxx/src/builders/guild/onboarding.dart';
 import 'package:nyxx/src/builders/guild/template.dart';
 import 'package:nyxx/src/builders/guild/welcome_screen.dart';
 import 'package:nyxx/src/builders/guild/widget.dart';
@@ -256,6 +257,7 @@ class GuildManager extends Manager<Guild> {
       prompts: parseMany(raw['prompts'] as List, (Map<String, Object?> raw) => parseOnboardingPrompt(raw, guildId: guildId)),
       defaultChannelIds: parseMany(raw['default_channel_ids'] as List, Snowflake.parse),
       isEnabled: raw['enabled'] as bool,
+      mode: OnboardingMode(raw['mode'] as int),
     );
   }
 
@@ -694,6 +696,17 @@ class GuildManager extends Manager<Guild> {
     return parseOnboarding(response.jsonBody as Map<String, Object?>);
   }
 
+  /// Update a guild's onboarding.
+  Future<Onboarding> updateOnboarding(Snowflake id, OnboardingUpdateBuilder builder, {String? auditLogReason}) async {
+    final route = HttpRoute()
+      ..guilds(id: id.toString())
+      ..onboarding();
+    final request = BasicRequest(route, method: 'PUT', body: jsonEncode(builder.build()), auditLogReason: auditLogReason);
+
+    final response = await client.httpHandler.executeSafe(request);
+    return parseOnboarding(response.jsonBody as Map<String, Object?>);
+  }
+
   /// Update the current user's voice state in a guild.
   Future<void> updateCurrentUserVoiceState(Snowflake id, CurrentUserVoiceStateUpdateBuilder builder) async {
     final route = HttpRoute()

lib/src/models/guild/guild.dart

@@ -2,6 +2,7 @@ import 'dart:typed_data';
 
 import 'package:nyxx/src/builders/channel/channel_position.dart';
 import 'package:nyxx/src/builders/channel/guild_channel.dart';
+import 'package:nyxx/src/builders/guild/onboarding.dart';
 import 'package:nyxx/src/builders/guild/template.dart';
 import 'package:nyxx/src/builders/guild/welcome_screen.dart';
 import 'package:nyxx/src/builders/guild/widget.dart';
@@ -168,6 +169,10 @@ class PartialGuild extends WritableSnowflakeEntity<Guild> {
   /// Fetch the onboarding information for this guild.
   Future<Onboarding> fetchOnboarding() => manager.fetchOnboarding(id);
 
+  /// Update this guild's onboarding.
+  Future<Onboarding> updateOnboarding(OnboardingUpdateBuilder builder, {String? auditLogReason}) =>
+      manager.updateOnboarding(id, builder, auditLogReason: auditLogReason);
+
   /// Update the current user's voice state in this guild.
   Future<void> updateCurrentUserVoiceState(CurrentUserVoiceStateUpdateBuilder builder) => manager.updateCurrentUserVoiceState(id, builder);
 

lib/src/models/guild/onboarding.dart

@@ -25,6 +25,9 @@ class Onboarding with ToStringHelper {
   /// Whether onboarding is enabled for this guild.
   final bool isEnabled;
 
+  /// The current onboarding mode.
+  final OnboardingMode mode;
+
   /// {@macro onboarding}
   /// @nodoc
   Onboarding({
@@ -33,6 +36,7 @@ class Onboarding with ToStringHelper {
     required this.prompts,
     required this.defaultChannelIds,
     required this.isEnabled,
+    required this.mode,
   });
 
   /// The guild this onboarding is for.
@@ -111,6 +115,9 @@ class OnboardingPromptOption with ToStringHelper {
   final List<Snowflake> roleIds;
 
   /// The emoji associated with this onboarding prompt.
+  // The `emoji_id`, `emoji_name`, and `emoji_animated` fields never seem to be
+  // included in this structure when it is returned from the API. Since the
+  // `emoji` object contains this information anyway, we don't include them.
   final Emoji? emoji;
 
   /// The title of this option.
@@ -134,3 +141,19 @@ class OnboardingPromptOption with ToStringHelper {
   /// The channels the user is granted access to.
   List<PartialChannel> get channels => channelIds.map((e) => manager.client.channels[e]).toList();
 }
+
+/// The mode under which onboarding constraints operate when creating an
+/// [Onboarding].
+///
+/// These constraints are that there must be at least 7 Default Channels and
+/// at least 5 of them must allow sending messages to the @everyone role.
+final class OnboardingMode extends EnumLike<int, OnboardingMode> {
+  /// Only default channels count towards the constraints.
+  static const defaultMode = OnboardingMode(0);
+
+  /// Both default channels and questions count towards the constraints,
+  static const advanced = OnboardingMode(1);
+
+  /// @nodoc
+  const OnboardingMode(super.value);
+}

test/unit/http/managers/guild_manager_test.dart

@@ -395,7 +395,10 @@ final sampleOnboarding = {
     "998678683592171602",
     "998678699715067986"
   ],
-  "enabled": true
+  "enabled": true,
+
+  // The docs say these fields are present, but they aren't in the sample onboarding Discord provides
+  "mode": 0,
 };
 
 void checkOnboarding(Onboarding onboarding) {
@@ -730,6 +733,22 @@ void main() {
         execute: (manager) => manager.fetchOnboarding(Snowflake.zero),
         check: checkOnboarding,
       ),
+      EndpointTest<GuildManager, Onboarding, Map<String, Object?>>(
+        name: 'updateOnboarding',
+        source: sampleOnboarding,
+        urlMatcher: '/guilds/0/onboarding',
+        method: 'PUT',
+        execute: (manager) => manager.updateOnboarding(
+          Snowflake.zero,
+          OnboardingUpdateBuilder(
+            prompts: [],
+            defaultChannelIds: [],
+            isEnabled: true,
+            mode: OnboardingMode.defaultMode,
+          ),
+        ),
+        check: checkOnboarding,
+      ),
       EndpointTest<GuildManager, void, void>(
         name: 'updateCurrentUserVoiceState',
         method: 'PATCH',