defmodule Nostrum.Struct.Event.MessageDeleteBulk do
  @moduledoc """
  Struct representing a Message Delete Bulk event
  """

  alias Nostrum.Struct.{Channel, Guild, Message}

  defstruct [
    :deleted_messages,
    :channel_id,
    :guild_id,
    :ids
  ]

  @typedoc "Channel id of the deleted message"
  @type channel_id :: Channel.id()

  @typedoc """
  Guild id of the deleted message

  `nil` if a non-guild message was deleted.
  """
  @type guild_id :: Guild.id() | nil

  @typedoc "Ids of the deleted messages"
  @type ids :: [Message.id(), ...]

  @typedoc """
  The deleted messages, if any were not found
  in the message cache they will only have the id and channel_id set.
  """
  @type deleted_messages :: [Message.t(), ...]
  @type t :: %__MODULE__{
          deleted_messages: deleted_messages,
          channel_id: channel_id,
          guild_id: guild_id,
          ids: ids
        }

  @doc false
  def to_struct(map), do: struct(__MODULE__, map)
end