Lingo.Api.AutoModeration (Lingo v0.4.2)

Auto moderation rules.

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, opts \\ [])

Creates an auto moderation rule.

delete(guild_id, rule_id, opts \\ [])

Deletes an auto moderation rule.

get(guild_id, rule_id)

Fetches an auto moderation rule.

list(guild_id)

Lists a guild's auto moderation rules.

update(guild_id, rule_id, params, opts \\ [])

Edits an auto moderation rule.

Functions

create(guild_id, params, opts \\ [])

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

Creates an auto moderation rule.

delete(guild_id, rule_id, opts \\ [])

@spec delete(Lingo.Api.id(), Lingo.Api.id(), keyword()) :: Lingo.Api.result()

Deletes an auto moderation rule.

get(guild_id, rule_id)

@spec get(Lingo.Api.id(), Lingo.Api.id()) ::
  Lingo.Api.result(Lingo.Type.AutoModerationRule.t())

Fetches an auto moderation rule.

list(guild_id)

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

Lists a guild's auto moderation rules.

update(guild_id, rule_id, params, opts \\ [])

@spec update(Lingo.Api.id(), Lingo.Api.id(), Lingo.Api.params(), keyword()) ::
  Lingo.Api.result(Lingo.Type.AutoModerationRule.t())

Edits an auto moderation rule.