feat(Guild): add api methods for membership screening

src/structures/Guild.js

@@ -170,8 +170,10 @@ class Guild extends Base {
      * * DISCOVERABLE
      * * FEATURABLE
      * * INVITE_SPLASH
+     * * MEMBER_VERIFICATION_GATE_ENABLED
      * * NEWS
      * * PARTNERED
+     * * PREVIEW_ENABLED
      * * RELAY_ENABLED
      * * VANITY_URL
      * * VERIFIED
@@ -484,6 +486,15 @@ class Guild extends Base {
     return new Date(this.joinedTimestamp);
   }
 
+  /**
+   * Whether Membership Screening is enabled on this guild
+   * @type {boolean}
+   * @readonly
+   */
+  get membershipScreeningEnabled() {
+    return this.features.includes('MEMBER_VERIFICATION_GATE_ENABLED');
+  }
+
   /**
    * If this guild is partnered
    * @type {boolean}
@@ -959,6 +970,49 @@ class Guild extends Base {
       .then(data => GuildAuditLogs.build(this, data));
   }
 
+  /**
+   * Data for a field in Membership Screening
+   * @typedef {Object} GuildMembershipScreeningField
+   * @property {MembershipScreeningType} fieldType The type of the field
+   * @property {string} label The title of the field
+   * @property {string[]} [values] The list of values in the field
+   * @property {boolean} required Whether the user has to fill out this field
+   */
+
+  /**
+   * Data for the Guild Membership Screening object
+   * @typedef {Object} GuildMembershipScreening
+   * @property {boolean} enabled Whether membership screening is enabled
+   * @property {string} description The server description shown in the membership screening form
+   * @property {GuildMembershipScreeningField[]} formFields The steps in the membership screening form
+   */
+
+  /**
+   * Fetches the guild Membership Screening data.
+   * @returns {Promise<GuildMembershipScreening>}
+   * @example
+   * // Fetches the guild membership screening options
+   * guild.fetchMembershipScreening()
+   *   .then(memberScreen => console.log(`Membership Screening is ${memberScreen.enabled ? 'enabled' : 'disabled'}`))
+   *   .catch(console.error);
+   */
+  async fetchMembershipScreening() {
+    if (!this.features.includes('COMMUNITY')) {
+      throw new Error('COMMUNITY');
+    }
+    const data = await this.client.api.guilds(this.id)['member-verification'].get();
+    return {
+      enabled: this.membershipScreeningEnabled,
+      description: data.description,
+      formFields: data.form_fields.map(field => ({
+        fieldType: field.field_type,
+        label: field.label,
+        values: field.values,
+        required: field.required,
+      })),
+    };
+  }
+
   /**
    * Adds a user to the guild using OAuth2. Requires the `CREATE_INSTANT_INVITE` permission.
    * @param {UserResolvable} user User to add to the guild
@@ -1422,6 +1476,45 @@ class Guild extends Base {
       .then(() => this);
   }
 
+  /**
+   * A `Partial` object is a representation of any existing object.
+   * This object contains between 1 and all of the original objects parameters.
+   * This is true regardless of whether the parameters are optional in the base object.
+   * @typedef {Object} Partial
+   */
+
+  /**
+   * Edits the guild's membership screening form.
+   * @param {Partial<GuildMembershipScreening>} memberScreen The membership screening data for the guild
+   * @returns {Promise<GuildMembershipScreening>}
+   */
+  async setMembershipScreening(memberScreen) {
+    if (!this.features.includes('COMMUNITY')) {
+      throw new Error('COMMUNITY');
+    }
+    const fields = memberScreen.formFields?.map(field => ({
+      field_type: field.field_type,
+      label: field.label,
+      values: field.values,
+      required: field.required,
+    }));
+    const data = {};
+    if (typeof memberScreen.enabled !== 'undefined') data.enabled = memberScreen.enabled;
+    if (typeof memberScreen.description !== 'undefined') data.description = memberScreen.description;
+    if (typeof memberScreen.formFields !== 'undefined') data.form_fields = JSON.stringify(fields);
+    const res = await this.client.api.guilds(this.id)['member-verification'].patch({ data });
+    return {
+      enabled: memberScreen.enabled,
+      description: res.description,
+      formFields: res.form_fields.map(field => ({
+        fieldType: field.field_type,
+        label: field.label,
+        values: field.values,
+        required: field.required,
+      })),
+    };
+  }
+
   /**
    * Leaves the guild.
    * @returns {Promise<Guild>}

src/util/Constants.js

@@ -512,6 +512,13 @@ exports.ExplicitContentFilterLevels = ['DISABLED', 'MEMBERS_WITHOUT_ROLES', 'ALL
  */
 exports.VerificationLevels = ['NONE', 'LOW', 'MEDIUM', 'HIGH', 'VERY_HIGH'];
 
+/**
+ * The type of membership screening. Here are the available types:
+ * * TERMS
+ * @typedef {string} MembershipScreeningType
+ */
+exports.MembershipScreeningType = ['TERMS'];
+
 /**
  * An error encountered while performing an API request. Here are the potential errors:
  * * UNKNOWN_ACCOUNT

typings/index.d.ts

@@ -519,6 +519,7 @@ declare module 'discord.js' {
     ExplicitContentFilterLevels: ExplicitContentFilterLevel[];
     DefaultMessageNotifications: DefaultMessageNotifications[];
     VerificationLevels: VerificationLevel[];
+    MembershipScreeningType: MembershipScreeningType[];
     MembershipStates: 'INVITED' | 'ACCEPTED';
   };
 
@@ -602,6 +603,7 @@ declare module 'discord.js' {
     public readonly me: GuildMember | null;
     public memberCount: number;
     public members: GuildMemberManager;
+    public readonly membershipScreeningEnabled: boolean;
     public mfaLevel: number;
     public name: string;
     public readonly nameAcronym: string;
@@ -647,6 +649,7 @@ declare module 'discord.js' {
     public fetchEmbed(): Promise<GuildWidget>;
     public fetchIntegrations(options?: FetchIntegrationsOptions): Promise<Collection<string, Integration>>;
     public fetchInvites(): Promise<Collection<string, Invite>>;
+    public fetchMembershipScreening(): Promise<GuildMembershipScreening>;
     public fetchPreview(): Promise<GuildPreview>;
     public fetchTemplates(): Promise<Collection<GuildTemplate['code'], GuildTemplate>>;
     public fetchVanityCode(): Promise<string>;
@@ -671,6 +674,7 @@ declare module 'discord.js' {
       reason?: string,
     ): Promise<Guild>;
     public setIcon(icon: Base64Resolvable | null, reason?: string): Promise<Guild>;
+    public setMembershipScreening(memberScreen: Partial<GuildMembershipScreening>): Promise<GuildMembershipScreening>;
     public setName(name: string, reason?: string): Promise<Guild>;
     public setOwner(owner: GuildMemberResolvable, reason?: string): Promise<Guild>;
     public setPreferredLocale(preferredLocale: string, reason?: string): Promise<Guild>;
@@ -2646,8 +2650,10 @@ declare module 'discord.js' {
     | 'DISCOVERABLE'
     | 'FEATURABLE'
     | 'INVITE_SPLASH'
+    | 'MEMBER_VERIFICATION_GATE_ENABLED'
     | 'NEWS'
     | 'PARTNERED'
+    | 'PREVIEW_ENABLED'
     | 'RELAY_ENABLED'
     | 'VANITY_URL'
     | 'VERIFIED'
@@ -2664,6 +2670,19 @@ declare module 'discord.js' {
 
   type GuildMemberResolvable = GuildMember | UserResolvable;
 
+  interface GuildMembershipScreening {
+    description: string;
+    enabled: boolean;
+    formFields: GuildMembershipScreeningField[];
+  }
+
+  interface GuildMembershipScreeningField {
+    fieldType: MembershipScreeningType;
+    label: string;
+    required: boolean;
+    values?: string;
+  }
+
   type GuildResolvable = Guild | GuildChannel | GuildMember | GuildEmoji | Invite | Role | Snowflake;
 
   interface GuildPruneMembersOptions {
@@ -2745,6 +2764,8 @@ declare module 'discord.js' {
 
   type GuildTemplateResolvable = string;
 
+  type MembershipScreeningType = 'TERMS';
+
   type MembershipStates = 'INVITED' | 'ACCEPTED';
 
   type MessageAdditions = MessageEmbed | MessageAttachment | (MessageEmbed | MessageAttachment)[];