GuildTemplate Class

seyfertlib/structures/GuildTemplate.d.ts

Signature

export declare class GuildTemplate extends Base

Properties

client code name description usageCount creatorId creator createdAt updatedAt sourceGuildId serializedSourceGuild isDirty

Methods

constructor guild fetch sync edit delete methods

Properties

client

readonly client: UsingClient;

code

code: string;

name

name: string;

description

description: string | null;

usageCount

usageCount: number;

creatorId

creatorId: string;

creator

creator: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: { asset: string; skuId: string; } | null | undefined; collectibles?: { nameplate?: APINameplateData | undefined; } | null | undefined; primaryGuild?: { identityGuildId: string | null; identityEnabled: boolean | null; tag: string | null; badge: string | null; } | null | undefined; };

createdAt

createdAt: string;

updatedAt

updatedAt: string;

sourceGuildId

sourceGuildId: string;

serializedSourceGuild

serializedSourceGuild: { description: string | null; preferredLocale: 'id' | 'en-US' | 'en-GB' | 'bg' | 'zh-CN' | 'zh-TW' | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'es-419' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi'; iconHash: string | null; roles?: { id: string | number; name?: string | null | undefined; permissions?: string | null | undefined; color?: number | null | undefined; colors?: { primaryColor: number; secondaryColor: number | null; tertiaryColor: number | null; } | undefined; hoist?: boolean | null | undefined; icon?: string | null | undefined; unicodeEmoji?: string | null | undefined; mentionable?: boolean | null | undefined; }[] | undefined; name: string; verificationLevel?: GuildVerificationLevel | undefined; afkChannelId?: string | number | null | undefined; afkTimeout?: 1800 | 3600 | 60 | 300 | 900 | undefined; defaultMessageNotifications?: GuildDefaultMessageNotifications | undefined; explicitContentFilter?: GuildExplicitContentFilter | undefined; systemChannelId?: string | number | null | undefined; systemChannelFlags?: GuildSystemChannelFlags | undefined; premiumProgressBarEnabled?: boolean | undefined; region?: string | undefined; channels?: ({ type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelType.GuildCategory | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; } | { type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelType.GuildForum | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; topic?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; rateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; defaultAutoArchiveDuration?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ThreadAutoArchiveDuration | undefined>; defaultThreadRateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; availableTags?: { id: string; name: string; moderated: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean>; emojiId: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; emojiName: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; }[] | undefined; defaultReactionEmoji?: { emojiId: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; emojiName: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; } | null | undefined; defaultSortOrder?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<SortOrderType | null | undefined>; defaultForumLayout?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ForumLayoutType | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; } | { type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelType.GuildMedia | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; topic?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; rateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; defaultAutoArchiveDuration?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ThreadAutoArchiveDuration | undefined>; defaultThreadRateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; availableTags?: { id: string; name: string; moderated: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean>; emojiId: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; emojiName: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; }[] | undefined; defaultReactionEmoji?: { emojiId: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; emojiName: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null>; } | null | undefined; defaultSortOrder?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<SortOrderType | null | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; } | { type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelType.GuildStageVoice | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; rateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; bitrate?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; userLimit?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; rtcRegion?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null | undefined>; videoQualityMode?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<VideoQualityMode | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; } | { type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelType.GuildVoice | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; rateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; bitrate?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; userLimit?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; rtcRegion?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null | undefined>; videoQualityMode?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<VideoQualityMode | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; } | { type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelType.GuildAnnouncement | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; topic?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; rateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; defaultAutoArchiveDuration?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ThreadAutoArchiveDuration | undefined>; defaultThreadRateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; } | { type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelType.GuildText | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; topic?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<string | null | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; rateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; defaultAutoArchiveDuration?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ThreadAutoArchiveDuration | undefined>; defaultThreadRateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; } | { type?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ThreadChannelType | undefined>; flags?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ChannelFlags | undefined>; position?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; nsfw?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<boolean | undefined>; rateLimitPerUser?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<number | undefined>; name: string; id?: string | number | undefined; parentId?: string | number | null | undefined; permissionOverwrites?: { id: string | number; allow?: string | null | undefined; deny?: string | null | undefined; type: OverwriteType; }[] | undefined; })[] | undefined; };

isDirty

isDirty: boolean | null;

Methods

constructorConstructor

constructor(client: UsingClient, data: APITemplate);

guild

guild(mode?: 'rest' | 'flow'): Promise<GuildStructure<'cached' | 'api'>>;guild(mode: 'cache'): ReturnCache<GuildStructure<'cached'> | undefined>;

fetch

fetch(): Promise<GuildTemplateStructure>;

sync

sync(): Promise<GuildTemplateStructure>;

edit

edit(body: RESTPatchAPIGuildTemplateJSONBody): Promise<GuildTemplateStructure>;

delete

delete(): Promise<GuildTemplateStructure>;

methods

static methods(ctx: MethodContext<{    guildId: string;}>): {    fetch: (code: string) => Promise<GuildTemplateStructure>;    list: () => Promise<GuildTemplateStructure[]>;    create: (body: RESTPostAPIGuildTemplatesJSONBody) => Promise<GuildTemplateStructure>;    sync: (code: string) => Promise<GuildTemplateStructure>;    edit: (code: string, body: RESTPatchAPIGuildTemplateJSONBody) => Promise<GuildTemplateStructure>;    delete: (code: string) => Promise<GuildTemplateStructure>;};