Guild

import type { Guild } from 'chapterjs';

async function describe(guild: Guild) {
  const owner = await guild.fetchOwner();
  return `${guild.name} has ${guild.memberCount} members and belongs to ${owner.displayName}.`;
}

iconURL(options?: ImageOptions): string | null

bannerURL(options?: ImageOptions): string | null

splashURL(options?: ImageOptions): string | null

toString(): string

toJSON(): object

fetch(): Promise<Guild>

fetchMember(user: Snowflake | { id: Snowflake }, options?: { force?: boolean }): Promise<GuildMember>

fetchMembers(options?: { limit?: number; after?: Snowflake | { id: Snowflake } }): Promise<GuildMember[]>

searchMembers(query: string, limit?: number): Promise<GuildMember[]>

fetchOwner(): Promise<GuildMember>

fetchBan(user: Snowflake | { id: Snowflake }): Promise<Ban | null>

fetchBans(options?: { limit?: number; before?: Snowflake; after?: Snowflake }): Promise<Ban[]>

fetchRoles(): Promise<Role[]>

fetchChannels(): Promise<GuildChannel[]>

fetchActiveThreads(): Promise<ThreadChannel[]>

fetchEmojis(): Promise<GuildEmoji[]>

fetchInvites(): Promise<Invite[]>

fetchWebhooks(): Promise<Webhook[]>

fetchAuditLog(options?: {
  userId?: Snowflake;
  actionType?: AuditLogEvent;
  before?: Snowflake;
  after?: Snowflake;
  limit?: number;
}): Promise<AuditLog>

fetchScheduledEvents(): Promise<ScheduledEvent[]>

fetchAutoModerationRules(): Promise<AutoModerationRule[]>

fetchStickers(): Promise<Sticker[]>

edit(options: GuildEditOptions, reason?: string): Promise<Guild>

leave(): Promise<void>

kick(user: Snowflake | { id: Snowflake }, reason?: string): Promise<void>

ban(user: Snowflake | { id: Snowflake }, options?: BanOptions): Promise<void>

bulkBan(
  users: readonly (Snowflake | { id: Snowflake })[],
  options?: BanOptions
): Promise<{ bannedUsers: Snowflake[]; failedUsers: Snowflake[] }>

unban(user: Snowflake | { id: Snowflake }, reason?: string): Promise<void>

createRole(options?: RoleCreateOptions, reason?: string): Promise<Role>

createChannel(options: ChannelCreateOptions, reason?: string): Promise<GuildChannel>

createEmoji(
  options: { name: string; image: string; roles?: (Snowflake | { id: Snowflake })[] },
  reason?: string
): Promise<GuildEmoji>

createScheduledEvent(
  options: {
    name: string;
    privacyLevel: number;
    scheduledStartTime: string;
    entityType: number;
    channelId?: Snowflake;
    entityMetadata?: { location?: string };
    scheduledEndTime?: string;
    description?: string;
    image?: string;
    recurrenceRule?: object;
  },
  reason?: string
): Promise<ScheduledEvent>