Class APIGuildRolePanel

Constructors

constructor

Methods

createRolePanel deleteRolePanel getGuildRolePanel getGuildRolePanels repostRolePanel updateRolePanel

Constructors

constructor

Methods

createRolePanel

  • createRolePanel(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          body: {
              assignMode:
                  | "toggle"
                  | "unique"
                  | "limit"
                  | "verify";
              boosterOnly?: null | boolean;
              channelId: string;
              embeds?: {
                  author: null | string;
                  authorIcon: null | string;
                  color: null | string;
                  description: string;
                  fields: {
                      inline: null | boolean;
                      name: string;
                      value: null | string;
                  }[];
                  footer: null | string;
                  footerIcon: null | string;
                  image: null | string;
                  order: number;
                  thumbnail: null | string;
                  title: null | string;
                  url: null | string;
              }[];
              guildId: string;
              interactionType: "buttons" | "reactions" | "dropdown";
              logChannelId?: null | string;
              maxRoles?: null | number;
              messageId?: null | string;
              name: string;
              panelId: string;
              requireAccountAgeDays?: null | number;
              requireJoinAgeDays?: null | number;
              requireMessageCount?: null | number;
              rows?: {
                  blacklistRoleIds: string[];
                  emojiUnicodeOrId: null | string;
                  label: null | string;
                  requiredRoleIds: string[];
                  roleId: string;
                  style: null | number;
                  temporaryMinutes: null | number;
              }[];
              webhookAvatarUrl?: null | string;
              webhookEnabled?: boolean;
              webhookUsername?: null | string;
          };
          guildId: string;
      }
      • auth: string
      • body: {
            assignMode:
                | "toggle"
                | "unique"
                | "limit"
                | "verify";
            boosterOnly?: null | boolean;
            channelId: string;
            embeds?: {
                author: null | string;
                authorIcon: null | string;
                color: null | string;
                description: string;
                fields: {
                    inline: null | boolean;
                    name: string;
                    value: null | string;
                }[];
                footer: null | string;
                footerIcon: null | string;
                image: null | string;
                order: number;
                thumbnail: null | string;
                title: null | string;
                url: null | string;
            }[];
            guildId: string;
            interactionType: "buttons" | "reactions" | "dropdown";
            logChannelId?: null | string;
            maxRoles?: null | number;
            messageId?: null | string;
            name: string;
            panelId: string;
            requireAccountAgeDays?: null | number;
            requireJoinAgeDays?: null | number;
            requireMessageCount?: null | number;
            rows?: {
                blacklistRoleIds: string[];
                emojiUnicodeOrId: null | string;
                label: null | string;
                requiredRoleIds: string[];
                roleId: string;
                style: null | number;
                temporaryMinutes: null | number;
            }[];
            webhookAvatarUrl?: null | string;
            webhookEnabled?: boolean;
            webhookUsername?: null | string;
        }
        • assignMode:
              | "toggle"
              | "unique"
              | "limit"
              | "verify"
        • OptionalboosterOnly?: null | boolean
        • channelId: string
        • Optionalembeds?: {
              author: null | string;
              authorIcon: null | string;
              color: null | string;
              description: string;
              fields: {
                  inline: null | boolean;
                  name: string;
                  value: null | string;
              }[];
              footer: null | string;
              footerIcon: null | string;
              image: null | string;
              order: number;
              thumbnail: null | string;
              title: null | string;
              url: null | string;
          }[]
        • guildId: string
        • interactionType: "buttons" | "reactions" | "dropdown"
        • OptionallogChannelId?: null | string
        • OptionalmaxRoles?: null | number
        • OptionalmessageId?: null | string
        • name: string
        • panelId: string
        • OptionalrequireAccountAgeDays?: null | number
        • OptionalrequireJoinAgeDays?: null | number
        • OptionalrequireMessageCount?: null | number
        • Optionalrows?: {
              blacklistRoleIds: string[];
              emojiUnicodeOrId: null | string;
              label: null | string;
              requiredRoleIds: string[];
              roleId: string;
              style: null | number;
              temporaryMinutes: null | number;
          }[]
        • OptionalwebhookAvatarUrl?: null | string
        • OptionalwebhookEnabled?: boolean
        • OptionalwebhookUsername?: null | string
      • guildId: string

    Returns Promise<WebResponse<string>>

deleteRolePanel

  • deleteRolePanel(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          guildId: string;
          panelId: string;
      }
      • auth: string
      • guildId: string
      • panelId: string

    Returns Promise<WebResponse<string>>

getGuildRolePanel

  • getGuildRolePanel(__namedParameters): Promise<WebResponse<{
        embeds: ({
            fields: ({
                guildRolePanelEmbed: (...) | (...);
            } & {
                dbId: string;
                guildRolePanelEmbedId: string;
                inline: (...) | (...) | (...);
                name: string;
                value: (...) | (...);
            })[];
        } & {
            author: null | string;
            authorIcon: null | string;
            color: null | string;
            dbId: string;
            description: string;
            footer: null | string;
            footerIcon: null | string;
            guildRolePanelId: string;
            image: null | string;
            order: number;
            thumbnail: null | string;
            title: null | string;
            url: null | string;
        })[];
        rows: {
            blacklistRoleIds: string[];
            dbId: string;
            emojiUnicodeOrId: null | string;
            guildRolePanelId: string;
            label: null | string;
            requiredRoleIds: string[];
            roleId: string;
            style: null | number;
            temporaryMinutes: null | number;
        }[];
    } & {
        assignMode: RolePanelAssignMode;
        boosterOnly: null | boolean;
        channelId: string;
        dbId: string;
        guildId: string;
        interactionType: RolePanelType;
        logChannelId: null | string;
        maxRoles: null | number;
        messageId: null | string;
        name: string;
        panelId: string;
        requireAccountAgeDays: null | number;
        requireJoinAgeDays: null | number;
        requireMessageCount: null | number;
        webhookAvatarUrl: null | string;
        webhookEnabled: boolean;
        webhookUsername: null | string;
    }>>

  • Parameters

    • __namedParameters: {
          auth: string;
          guildId: string;
          panelId: string;
      }
      • auth: string
      • guildId: string
      • panelId: string

    Returns Promise<WebResponse<{
        embeds: ({
            fields: ({
                guildRolePanelEmbed: (...) | (...);
            } & {
                dbId: string;
                guildRolePanelEmbedId: string;
                inline: (...) | (...) | (...);
                name: string;
                value: (...) | (...);
            })[];
        } & {
            author: null | string;
            authorIcon: null | string;
            color: null | string;
            dbId: string;
            description: string;
            footer: null | string;
            footerIcon: null | string;
            guildRolePanelId: string;
            image: null | string;
            order: number;
            thumbnail: null | string;
            title: null | string;
            url: null | string;
        })[];
        rows: {
            blacklistRoleIds: string[];
            dbId: string;
            emojiUnicodeOrId: null | string;
            guildRolePanelId: string;
            label: null | string;
            requiredRoleIds: string[];
            roleId: string;
            style: null | number;
            temporaryMinutes: null | number;
        }[];
    } & {
        assignMode: RolePanelAssignMode;
        boosterOnly: null | boolean;
        channelId: string;
        dbId: string;
        guildId: string;
        interactionType: RolePanelType;
        logChannelId: null | string;
        maxRoles: null | number;
        messageId: null | string;
        name: string;
        panelId: string;
        requireAccountAgeDays: null | number;
        requireJoinAgeDays: null | number;
        requireMessageCount: null | number;
        webhookAvatarUrl: null | string;
        webhookEnabled: boolean;
        webhookUsername: null | string;
    }>>

getGuildRolePanels

  • getGuildRolePanels(__namedParameters): Promise<WebResponse<({
        embeds: ({
            fields: ({
                guildRolePanelEmbed: ...;
            } & {
                dbId: ...;
                guildRolePanelEmbedId: ...;
                inline: ...;
                name: ...;
                value: ...;
            })[];
        } & {
            author: null | string;
            authorIcon: null | string;
            color: null | string;
            dbId: string;
            description: string;
            footer: null | string;
            footerIcon: null | string;
            guildRolePanelId: string;
            image: null | string;
            order: number;
            thumbnail: null | string;
            title: null | string;
            url: null | string;
        })[];
        rows: {
            blacklistRoleIds: string[];
            dbId: string;
            emojiUnicodeOrId: null | string;
            guildRolePanelId: string;
            label: null | string;
            requiredRoleIds: string[];
            roleId: string;
            style: null | number;
            temporaryMinutes: null | number;
        }[];
    } & {
        assignMode: RolePanelAssignMode;
        boosterOnly: null | boolean;
        channelId: string;
        dbId: string;
        guildId: string;
        interactionType: RolePanelType;
        logChannelId: null | string;
        maxRoles: null | number;
        messageId: null | string;
        name: string;
        panelId: string;
        requireAccountAgeDays: null | number;
        requireJoinAgeDays: null | number;
        requireMessageCount: null | number;
        webhookAvatarUrl: null | string;
        webhookEnabled: boolean;
        webhookUsername: null | string;
    })[]>>

  • Parameters

    • __namedParameters: {
          auth: string;
          guildId: string;
      }
      • auth: string
      • guildId: string

    Returns Promise<WebResponse<({
        embeds: ({
            fields: ({
                guildRolePanelEmbed: ...;
            } & {
                dbId: ...;
                guildRolePanelEmbedId: ...;
                inline: ...;
                name: ...;
                value: ...;
            })[];
        } & {
            author: null | string;
            authorIcon: null | string;
            color: null | string;
            dbId: string;
            description: string;
            footer: null | string;
            footerIcon: null | string;
            guildRolePanelId: string;
            image: null | string;
            order: number;
            thumbnail: null | string;
            title: null | string;
            url: null | string;
        })[];
        rows: {
            blacklistRoleIds: string[];
            dbId: string;
            emojiUnicodeOrId: null | string;
            guildRolePanelId: string;
            label: null | string;
            requiredRoleIds: string[];
            roleId: string;
            style: null | number;
            temporaryMinutes: null | number;
        }[];
    } & {
        assignMode: RolePanelAssignMode;
        boosterOnly: null | boolean;
        channelId: string;
        dbId: string;
        guildId: string;
        interactionType: RolePanelType;
        logChannelId: null | string;
        maxRoles: null | number;
        messageId: null | string;
        name: string;
        panelId: string;
        requireAccountAgeDays: null | number;
        requireJoinAgeDays: null | number;
        requireMessageCount: null | number;
        webhookAvatarUrl: null | string;
        webhookEnabled: boolean;
        webhookUsername: null | string;
    })[]>>

repostRolePanel

  • repostRolePanel(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          guildId: string;
          panelId: string;
      }
      • auth: string
      • guildId: string
      • panelId: string

    Returns Promise<WebResponse<string>>

updateRolePanel

  • updateRolePanel(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          body: {
              assignMode?:
                  | "toggle"
                  | "unique"
                  | "limit"
                  | "verify";
              boosterOnly?: null | boolean;
              channelId?: string;
              embeds?: {
                  author?: null | string;
                  authorIcon?: null | string;
                  color?: null | string;
                  description?: string;
                  fields?: {
                      inline?: null | boolean;
                      name?: string;
                      value?: null | string;
                  }[];
                  footer?: null | string;
                  footerIcon?: null | string;
                  image?: null | string;
                  order?: number;
                  thumbnail?: null | string;
                  title?: null | string;
                  url?: null | string;
              }[];
              guildId?: string;
              interactionType?: "buttons" | "reactions" | "dropdown";
              logChannelId?: null | string;
              maxRoles?: null | number;
              messageId?: null | string;
              name?: string;
              panelId?: string;
              requireAccountAgeDays?: null | number;
              requireJoinAgeDays?: null | number;
              requireMessageCount?: null | number;
              rows?: {
                  blacklistRoleIds?: string[];
                  emojiUnicodeOrId?: null | string;
                  label?: null | string;
                  requiredRoleIds?: string[];
                  roleId?: string;
                  style?: null | number;
                  temporaryMinutes?: null | number;
              }[];
              webhookAvatarUrl?: null | string;
              webhookEnabled?: boolean;
              webhookUsername?: null | string;
          };
          guildId: string;
          panelId: string;
      }
      • auth: string
      • body: {
            assignMode?:
                | "toggle"
                | "unique"
                | "limit"
                | "verify";
            boosterOnly?: null | boolean;
            channelId?: string;
            embeds?: {
                author?: null | string;
                authorIcon?: null | string;
                color?: null | string;
                description?: string;
                fields?: {
                    inline?: null | boolean;
                    name?: string;
                    value?: null | string;
                }[];
                footer?: null | string;
                footerIcon?: null | string;
                image?: null | string;
                order?: number;
                thumbnail?: null | string;
                title?: null | string;
                url?: null | string;
            }[];
            guildId?: string;
            interactionType?: "buttons" | "reactions" | "dropdown";
            logChannelId?: null | string;
            maxRoles?: null | number;
            messageId?: null | string;
            name?: string;
            panelId?: string;
            requireAccountAgeDays?: null | number;
            requireJoinAgeDays?: null | number;
            requireMessageCount?: null | number;
            rows?: {
                blacklistRoleIds?: string[];
                emojiUnicodeOrId?: null | string;
                label?: null | string;
                requiredRoleIds?: string[];
                roleId?: string;
                style?: null | number;
                temporaryMinutes?: null | number;
            }[];
            webhookAvatarUrl?: null | string;
            webhookEnabled?: boolean;
            webhookUsername?: null | string;
        }
        • OptionalassignMode?:
              | "toggle"
              | "unique"
              | "limit"
              | "verify"
        • OptionalboosterOnly?: null | boolean
        • OptionalchannelId?: string
        • Optionalembeds?: {
              author?: null | string;
              authorIcon?: null | string;
              color?: null | string;
              description?: string;
              fields?: {
                  inline?: null | boolean;
                  name?: string;
                  value?: null | string;
              }[];
              footer?: null | string;
              footerIcon?: null | string;
              image?: null | string;
              order?: number;
              thumbnail?: null | string;
              title?: null | string;
              url?: null | string;
          }[]
        • OptionalguildId?: string
        • OptionalinteractionType?: "buttons" | "reactions" | "dropdown"
        • OptionallogChannelId?: null | string
        • OptionalmaxRoles?: null | number
        • OptionalmessageId?: null | string
        • Optionalname?: string
        • OptionalpanelId?: string
        • OptionalrequireAccountAgeDays?: null | number
        • OptionalrequireJoinAgeDays?: null | number
        • OptionalrequireMessageCount?: null | number
        • Optionalrows?: {
              blacklistRoleIds?: string[];
              emojiUnicodeOrId?: null | string;
              label?: null | string;
              requiredRoleIds?: string[];
              roleId?: string;
              style?: null | number;
              temporaryMinutes?: null | number;
          }[]
        • OptionalwebhookAvatarUrl?: null | string
        • OptionalwebhookEnabled?: boolean
        • OptionalwebhookUsername?: null | string
      • guildId: string
      • panelId: string

    Returns Promise<WebResponse<string>>

Settings

Member Visibility

On This Page

Constructors
Methods