Lingo.Api.Template (Lingo v0.4.2)

Guild templates.

Every function returns {:ok, result}, :ok when Discord sends no body, or {:error, %Lingo.Error{}}. Calls go to the current bot (see Lingo.with_bot/2).

Summary

Functions

create(guild_id, params)

Creates a template from a guild.

delete(guild_id, template_code)

Deletes a guild template, returning it.

get(template_code)

Fetches a guild template by code.

list(guild_id)

Lists a guild's templates.

sync(guild_id, template_code)

Updates a template to the guild's current state.

update(guild_id, template_code, params)

Edits a guild template.

Functions

create(guild_id, params)

@spec create(Lingo.Api.id(), Lingo.Api.params()) ::
  Lingo.Api.result(Lingo.Type.GuildTemplate.t())

Creates a template from a guild.

delete(guild_id, template_code)

@spec delete(Lingo.Api.id(), String.t()) ::
  Lingo.Api.result(Lingo.Type.GuildTemplate.t())

Deletes a guild template, returning it.

get(template_code)

@spec get(String.t()) :: Lingo.Api.result(Lingo.Type.GuildTemplate.t())

Fetches a guild template by code.

list(guild_id)

@spec list(Lingo.Api.id()) :: Lingo.Api.result([Lingo.Type.GuildTemplate.t()])

Lists a guild's templates.

sync(guild_id, template_code)

@spec sync(Lingo.Api.id(), String.t()) ::
  Lingo.Api.result(Lingo.Type.GuildTemplate.t())

Updates a template to the guild's current state.

update(guild_id, template_code, params)

@spec update(Lingo.Api.id(), String.t(), Lingo.Api.params()) ::
  Lingo.Api.result(Lingo.Type.GuildTemplate.t())

Edits a guild template.