GuildTemplate

Extends

Base.ObjectToLower<APITemplate>

Constructors

new GuildTemplate(client, data)

1
new GuildTemplate(client: UsingClient, data: APITemplate): GuildTemplate

Parameters

Parameter	Type
`client`	`UsingClient`
`data`	`APITemplate`

Returns

GuildTemplate

Inherited from

Base.constructor

Source

seyfert/src/structures/GuildTemplate.ts:13

Properties

Property	Modifier	Type	Inherited from
`client`	`readonly`	`UsingClient`	`Base.client`
`code`	`public`	`string`	`ObjectToLower.code`
`createdAt`	`public`	`string`	`ObjectToLower.createdAt`
`creator`	`public`	`Object`	`ObjectToLower.creator`
`creator.accentColor`	`public`	`undefined` \| `null` \| `number`	-
`creator.avatar`	`public`	`null` \| `string`	-
`creator.avatarDecoration`	`public`	`undefined` \| `null` \| `string`	-
`creator.banner`	`public`	`undefined` \| `null` \| `string`	-
`creator.bot`	`public`	`undefined` \| `boolean`	-
`creator.discriminator`	`public`	`string`	-
`creator.email`	`public`	`undefined` \| `null` \| `string`	-
`creator.flags`	`public`	`undefined` \| `UserFlags`	-
`creator.globalName`	`public`	`null` \| `string`	-
`creator.id`	`public`	`string`	-
`creator.locale`	`public`	`undefined` \| `string`	-
`creator.mfaEnabled`	`public`	`undefined` \| `boolean`	-
`creator.premiumType`	`public`	`undefined` \| `UserPremiumType`	-
`creator.publicFlags`	`public`	`undefined` \| `UserFlags`	-
`creator.system`	`public`	`undefined` \| `boolean`	-
`creator.username`	`public`	`string`	-
`creator.verified`	`public`	`undefined` \| `boolean`	-
`creatorId`	`public`	`string`	`ObjectToLower.creatorId`
`description`	`public`	`null` \| `string`	`ObjectToLower.description`
`isDirty`	`public`	`null` \| `boolean`	`ObjectToLower.isDirty`
`name`	`public`	`string`	`ObjectToLower.name`
`serializedSourceGuild`	`public`	`Object`	`ObjectToLower.serializedSourceGuild`
`serializedSourceGuild.afkChannelId`	`public`	`undefined` \| `null` \| `string` \| `number`	-
`serializedSourceGuild.afkTimeout`	`public`	\| `undefined` \| `1800` \| `3600` \| `60` \| `300` \| `900`	-
`serializedSourceGuild.channels`	`public`	`undefined` \| ( \| `Object` \| `Object` \| `Object` \| `Object` \| `Object` \| `Object` \| `Object` \| `Object`)[]	-
`serializedSourceGuild.defaultMessageNotifications`	`public`	`undefined` \| `GuildDefaultMessageNotifications`	-
`serializedSourceGuild.description`	`public`	`null` \| `string`	-
`serializedSourceGuild.explicitContentFilter`	`public`	`undefined` \| `GuildExplicitContentFilter`	-
`serializedSourceGuild.iconHash`	`public`	`null` \| `string`	-
`serializedSourceGuild.name`	`public`	`string`	-
`serializedSourceGuild.preferredLocale`	`public`	`string`	-
`serializedSourceGuild.premiumProgressBarEnabled`	`public`	`undefined` \| `boolean`	-
`serializedSourceGuild.region`	`public`	`undefined` \| `string`	-
`serializedSourceGuild.roles`	`public`	`undefined` \| `Object`[]	-
`serializedSourceGuild.systemChannelFlags`	`public`	`undefined` \| `GuildSystemChannelFlags`	-
`serializedSourceGuild.systemChannelId`	`public`	`undefined` \| `null` \| `string` \| `number`	-
`serializedSourceGuild.verificationLevel`	`public`	`undefined` \| `GuildVerificationLevel`	-
`sourceGuildId`	`public`	`string`	`ObjectToLower.sourceGuildId`
`updatedAt`	`public`	`string`	`ObjectToLower.updatedAt`
`usageCount`	`public`	`number`	`ObjectToLower.usageCount`

Methods

delete()

1
delete(): Promise<GuildTemplate>

Returns

Promise<GuildTemplate>

Source

seyfert/src/structures/GuildTemplate.ts:34

edit()

1
edit(body: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<RESTPostAPIGuildTemplatesJSONBody>>): Promise<GuildTemplate>

Parameters

Parameter	Type
`body`	`AddUndefinedToPossiblyUndefinedPropertiesOfInterface`<`Partial`<`RESTPostAPIGuildTemplatesJSONBody`>>

Returns

Promise<GuildTemplate>

Source

seyfert/src/structures/GuildTemplate.ts:30

fetch()

1
fetch(): Promise<GuildTemplate>

Returns

Promise<GuildTemplate>

Source

seyfert/src/structures/GuildTemplate.ts:22

guild()

1
guild(force: boolean): Promise<Guild<"cached"> | Guild<"api">>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<Guild<"cached"> | Guild<"api">>

Source

seyfert/src/structures/GuildTemplate.ts:18

sync()

1
sync(): Promise<GuildTemplate>

Returns

Promise<GuildTemplate>

Source

seyfert/src/structures/GuildTemplate.ts:26

methods()

1
static methods(ctx:     Object): Object

Parameters

Parameter	Type
`ctx`	`Object`
`ctx.client`	`UsingClient`
`ctx.guildId`	`string`

Returns

Object

Member	Type	Value
`create`	(`body`: `RESTPostAPIGuildTemplatesJSONBody`) => `Promise`<`GuildTemplate`>	-
`delete`	(`code`: `string`) => `Promise`<`GuildTemplate`>	-
`edit`	(`code`: `string`, `body`: `AddUndefinedToPossiblyUndefinedPropertiesOfInterface`<`Partial`<`RESTPostAPIGuildTemplatesJSONBody`>>) => `Promise`<`GuildTemplate`>	-
`fetch`	(`code`: `string`) => `Promise`<`GuildTemplate`>	-
`list`	() => `Promise`<`GuildTemplate`[]>	-
`sync`	(`code`: `string`) => `Promise`<`GuildTemplate`>	-

Source

seyfert/src/structures/GuildTemplate.ts:38