Skip to content

Resources

guild_template

GuildTemplate dataclass

Bases: BaseResource


              flowchart TD
              scurrypy.resources.guild_template.GuildTemplate[GuildTemplate]
              scurrypy.resources.base_resource.BaseResource[BaseResource]

                              scurrypy.resources.base_resource.BaseResource --> scurrypy.resources.guild_template.GuildTemplate
                


              click scurrypy.resources.guild_template.GuildTemplate href "" "scurrypy.resources.guild_template.GuildTemplate"
              click scurrypy.resources.base_resource.BaseResource href "" "scurrypy.resources.base_resource.BaseResource"

Represents a guild template resource.

fetch async

Fetch a guild template.

Parameters:

  • template_code (str) –

    code of guild template to fetch

Returns:

fetch_guild async

Fetch all of a guild's templates.

Permissions

Requires MANAGE_GUILD

Parameters:

  • guild_id (Snowflake) –

    ID of guild to fetch guild templates

Returns:

  • list[GuildTemplateModel] –

    queried list of guild templates

create async

Create a template for a guild.

Permissions

Requires MANAGE_GUILD

Parameters:

  • guild_id (Snowflake) –

    guild ID of which the guild template will belong

  • template (GuildTemplatePart) –

    guild template to create

Returns:

  • GuildTemplateModel –

    created guild template

sync async

Syncs the guild template to a guild's current state.

Permissions

Requires MANAGE_GUILD

Parameters:

  • guild_id (Snowflake) –

    guild ID of which to sync the guild template

  • template_code (str) –

    code of guild template to sync

Returns:

edit async

Edit a guild template.

Permissions

Requires MANAGE_GUILD

Parameters:

  • guild_id (Snowflake) –

    guild ID of the guild template to edit

  • template_code (str) –

    code of the guild template to edit

  • options (EditGuildTemplateParams) –

    fields to edit

Returns:

delete async

Delete a guild template

Permissions

Requires MANAGE_GUILD

Parameters:

  • guild_id (Snowflake) –

    guild ID of the guild template to delete

  • template_code (str) –

    code of the guild template to delete