defmodule WeChat.Comment do
  @moduledoc """
  图文消息留言管理

  [官方文档](https://developers.weixin.qq.com/doc/offiaccount/Comments_management/Image_Comments_Management_Interface.html){:target="_blank"}
  """
  import Jason.Helpers

  @doc_link "https://developers.weixin.qq.com/doc/offiaccount/Comments_management/Image_Comments_Management_Interface.html"

  @type msg_data_id :: integer
  @type user_comment_id :: integer
  @typedoc """
  评论类型
    * `0` - 普通评论&精选评论
    * `1` - 普通评论
    * `2` - 精选评论
  """
  @type comment_type :: 0 | 1 | 2
  @type content :: String.t()

  @doc """
  打开已群发文章评论 -
  [官方文档](#{@doc_link}){:target="_blank"}
  """
  @spec open(WeChat.client(), msg_data_id, index :: integer) :: WeChat.response()
  def open(client, msg_data_id, index \\ 0) do
    client.post(
      "/cgi-bin/comment/open",
      json_map(msg_data_id: msg_data_id, index: index),
      query: [access_token: client.get_access_token()]
    )
  end

  @doc """
  关闭已群发文章评论 -
  [官方文档](#{@doc_link}){:target="_blank"}
  """
  @spec close(WeChat.client(), msg_data_id, index :: integer) :: WeChat.response()
  def close(client, msg_data_id, index \\ 0) do
    client.post(
      "/cgi-bin/comment/close",
      json_map(msg_data_id: msg_data_id, index: index),
      query: [access_token: client.get_access_token()]
    )
  end

  @doc """
  查看指定文章的评论数据 -
  [官方文档](#{@doc_link}){:target="_blank"}
    
  ## 参数说明
  | 参数 | 是否必须 | 类型 | 说明 |
  | -- | ------- | --- | --- |
  | msg_data_id | 是 | Uint32 | 群发返回的msg_data_id |
  | index | 否 | Uint32 | 多图文时，用来指定第几篇图文，从0开始，不带默认返回该msg_data_id的第一篇图文 |
  | begin | 是 | Uint32 | 起始位置 |
  | count | 是 | Uint32 | 获取数目（>=50会被拒绝） |
  | type | 是 | Uint32 | type=0 普通评论&精选评论 type=1 普通评论 type=2 精选评论 |
  """
  @spec list(
          WeChat.client(),
          msg_data_id,
          begin :: integer,
          count :: integer,
          comment_type,
          index :: integer
        ) :: WeChat.response()
  def list(client, msg_data_id, begin, count, type, index \\ 0)
      when count <= 50 and type in 0..2 do
    client.post(
      "/cgi-bin/comment/list",
      json_map(
        msg_data_id: msg_data_id,
        index: index,
        begin: begin,
        count: count,
        type: type
      ),
      query: [access_token: client.get_access_token()]
    )
  end

  @doc """
  将评论标记精选 -
  [官方文档](#{@doc_link}){:target="_blank"}
  """
  @spec mark_elect(WeChat.client(), msg_data_id, user_comment_id, index :: integer) ::
          WeChat.response()
  def mark_elect(client, msg_data_id, user_comment_id, index \\ 0) do
    client.post(
      "/cgi-bin/comment/markelect",
      json_map(
        msg_data_id: msg_data_id,
        index: index,
        user_comment_id: user_comment_id
      ),
      query: [access_token: client.get_access_token()]
    )
  end

  @doc """
  将评论取消精选 -
  [官方文档](#{@doc_link}){:target="_blank"}
  """
  @spec unmark_elect(WeChat.client(), msg_data_id, user_comment_id, index :: integer) ::
          WeChat.response()
  def unmark_elect(client, msg_data_id, user_comment_id, index \\ 0) do
    client.post(
      "/cgi-bin/comment/unmarkelect",
      json_map(
        msg_data_id: msg_data_id,
        index: index,
        user_comment_id: user_comment_id
      ),
      query: [access_token: client.get_access_token()]
    )
  end

  @doc """
  删除评论 -
  [官方文档](#{@doc_link}){:target="_blank"}
  """
  @spec delete(WeChat.client(), msg_data_id, user_comment_id, index :: integer) ::
          WeChat.response()
  def delete(client, msg_data_id, user_comment_id, index \\ 0) do
    client.post(
      "/cgi-bin/comment/delete",
      json_map(
        msg_data_id: msg_data_id,
        index: index,
        user_comment_id: user_comment_id
      ),
      query: [access_token: client.get_access_token()]
    )
  end

  @doc """
  回复评论 -
  [官方文档](#{@doc_link}){:target="_blank"}
  """
  @spec add_reply(WeChat.client(), msg_data_id, user_comment_id, content, index :: integer) ::
          WeChat.response()
  def add_reply(client, msg_data_id, user_comment_id, content, index \\ 0) do
    client.post(
      "/cgi-bin/comment/reply/add",
      json_map(
        msg_data_id: msg_data_id,
        index: index,
        user_comment_id: user_comment_id,
        content: content
      ),
      query: [access_token: client.get_access_token()]
    )
  end

  @doc """
  删除回复 -
  [官方文档](#{@doc_link}){:target="_blank"}
  """
  @spec delete_reply(WeChat.client(), msg_data_id, user_comment_id, index :: integer) ::
          WeChat.response()
  def delete_reply(client, msg_data_id, user_comment_id, index \\ 0) do
    client.post(
      "/cgi-bin/comment/reply/delete",
      json_map(
        msg_data_id: msg_data_id,
        index: index,
        user_comment_id: user_comment_id
      ),
      query: [access_token: client.get_access_token()]
    )
  end
end